Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED)
0.1.0 - ci-build
Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://example.org/StructureDefinition/MOPEDPatientLGF | Version: 0.1.0 | |||
Draft as of 2024-12-13 | Responsible: ELGA | Computable Name: MOPEDPatientLGF |
MOPED Profil der Patient Ressource aus der Sicht der Rolle: LGF
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HL7ATCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services | |
Slices for extension | Content/Rules for all slices | |||
extension:PatientReligion | 0..0 | |||
identifier | 0..0 | |||
Slices for identifier | Content/Rules for all slices | |||
identifier:socialSecurityNumber | 0..0 | |||
identifier:bPK | 0..0 | |||
identifier:localPatientId | 0..0 | |||
name | ||||
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
data-absent-reason | 1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |
value[x] | 1..1 | code | Value of extension Required Pattern: masked | |
telecom | 0..0 | |||
address | ||||
text | 0..0 | |||
line | 0..0 | |||
city | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | Content/Rules for all slices | |||
citizenship | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for extension | Content/Rules for all slices | |||
extension:code | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "code" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: https://termgit.elga.gv.at/ValueSet/elga-laendercodes (extensible) ele-1: All FHIR elements must have a @value or children | |
extension:period | 0..1 | Extension | Time period of citizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "period" | |
value[x] | 1..1 | Period | Value of extension ele-1: All FHIR elements must have a @value or children | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
birthPlace | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
value[x] | C | 1..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
name | Σ | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
data-absent-reason | 1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
value[x] | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Required Pattern: masked | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
Slices for extension | Content/Rules for all slices | |||
AdministrativeGenderAddition | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children |
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children |
Slices for multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
multipleBirth[x]:multipleBirthBoolean | 0..1 | boolean | Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children | |
multipleBirth[x]:multipleBirthInteger | 0..1 | integer | Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children | |
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.extension:citizenship.extension:code.value[x] | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodeshttps://termgit.elga.gv.at/ValueSet/elga-laendercodes | |
Patient.identifier:socialSecurityNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:bPK.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:localPatientId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.name.extension:data-absent-reason.value[x] | required | Pattern: maskedhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
at-addr-1 | error | Patient.extension:birthPlace.value[x] | If the extension for street name is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) | |
at-addr-2 | error | Patient.extension:birthPlace.value[x] | If the extension for street number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) | |
at-addr-3 | error | Patient.extension:birthPlace.value[x] | If the extension for floor/door number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services | |||||
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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
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 | |||||||
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 | |||||||
url | 1..1 | uri | "period" | |||||
value[x] | 1..1 | Period | Value of extension | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||
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 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | C | 1..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
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 | id | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
data-absent-reason | 1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
value[x] | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Required Pattern: masked | |||||
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 | ||||
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 | |||||
AdministrativeGenderAddition | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required) | |||||
value | 0..1 | code | Primitive value for code | |||||
birthDate | Σ | 0..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 | C | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty | ||||
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 | |||||
municipalityCode | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/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 (home / work / etc.). Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
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. may be ISO 3166 2 or 3 letter code) | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |||||
id | 0..1 | id | 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 | id | 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 | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 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 pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
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 | id | 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 | id | 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 | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 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 | C | 0..1 | HumanName | A name associated with the contact person | ||||
id | 0..1 | id | 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 | C | 0..* | ContactPoint | A contact detail for the person | ||||
id | 0..1 | id | 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 | ΣC | 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 | C | 0..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty | ||||
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 | |||||
municipalityCode | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/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 (home / work / etc.). 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 | |||||
street | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
streetNumber | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
floorDoorNumber | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
additionalInformation | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/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. may 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 | |||||
AdministrativeGenderAddition | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required) | |||||
value | 0..1 | code | Primitive value for code | |||||
organization | C | 0..1 | Reference(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: AllLanguages (required): IETF language tag for a human language
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||||
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(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, or Patient/RelatedPerson when using the seealso code | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.extension:citizenship.extension:code.value[x] | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodeshttps://termgit.elga.gv.at/ValueSet/elga-laendercodes | |
Patient.identifier:socialSecurityNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:socialSecurityNumber.type | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttps://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | |
Patient.identifier:socialSecurityNumber.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Patient.identifier:bPK.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:bPK.type | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttps://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | |
Patient.identifier:bPK.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Patient.identifier:localPatientId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:localPatientId.type | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttps://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | |
Patient.name.extension:data-absent-reason.value[x] | required | Pattern: maskedhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Patient.maritalStatus | extensible | MaritalStatusCodeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | |
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.contact.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Patient.contact.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.communication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
at-addr-1 | error | Patient.extension:birthPlace.value[x], Patient.address, Patient.contact.address | If the extension for street name is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) | |
at-addr-2 | error | Patient.extension:birthPlace.value[x], Patient.address, Patient.contact.address | If the extension for street number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) | |
at-addr-3 | error | Patient.extension:birthPlace.value[x], Patient.address, Patient.contact.address | If the extension for floor/door number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Differential View
This structure is derived from HL7ATCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services | |
Slices for extension | Content/Rules for all slices | |||
extension:PatientReligion | 0..0 | |||
identifier | 0..0 | |||
Slices for identifier | Content/Rules for all slices | |||
identifier:socialSecurityNumber | 0..0 | |||
identifier:bPK | 0..0 | |||
identifier:localPatientId | 0..0 | |||
name | ||||
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
data-absent-reason | 1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |
value[x] | 1..1 | code | Value of extension Required Pattern: masked | |
telecom | 0..0 | |||
address | ||||
text | 0..0 | |||
line | 0..0 | |||
city | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | Content/Rules for all slices | |||
citizenship | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for extension | Content/Rules for all slices | |||
extension:code | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "code" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: https://termgit.elga.gv.at/ValueSet/elga-laendercodes (extensible) ele-1: All FHIR elements must have a @value or children | |
extension:period | 0..1 | Extension | Time period of citizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "period" | |
value[x] | 1..1 | Period | Value of extension ele-1: All FHIR elements must have a @value or children | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
birthPlace | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
value[x] | C | 1..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
name | Σ | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
data-absent-reason | 1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
value[x] | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Required Pattern: masked | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
Slices for extension | Content/Rules for all slices | |||
AdministrativeGenderAddition | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children |
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children |
Slices for multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
multipleBirth[x]:multipleBirthBoolean | 0..1 | boolean | Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children | |
multipleBirth[x]:multipleBirthInteger | 0..1 | integer | Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children | |
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.extension:citizenship.extension:code.value[x] | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodeshttps://termgit.elga.gv.at/ValueSet/elga-laendercodes | |
Patient.identifier:socialSecurityNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:bPK.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:localPatientId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.name.extension:data-absent-reason.value[x] | required | Pattern: maskedhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
at-addr-1 | error | Patient.extension:birthPlace.value[x] | If the extension for street name is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) | |
at-addr-2 | error | Patient.extension:birthPlace.value[x] | If the extension for street number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) | |
at-addr-3 | error | Patient.extension:birthPlace.value[x] | If the extension for floor/door number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services | |||||
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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
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 | |||||||
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 | |||||||
url | 1..1 | uri | "period" | |||||
value[x] | 1..1 | Period | Value of extension | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||
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 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | C | 1..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
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 | id | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
data-absent-reason | 1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
value[x] | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Required Pattern: masked | |||||
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 | ||||
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 | |||||
AdministrativeGenderAddition | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required) | |||||
value | 0..1 | code | Primitive value for code | |||||
birthDate | Σ | 0..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 | C | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty | ||||
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 | |||||
municipalityCode | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/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 (home / work / etc.). Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
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. may be ISO 3166 2 or 3 letter code) | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |||||
id | 0..1 | id | 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 | id | 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 | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 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 pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
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 | id | 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 | id | 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 | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 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 | C | 0..1 | HumanName | A name associated with the contact person | ||||
id | 0..1 | id | 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 | C | 0..* | ContactPoint | A contact detail for the person | ||||
id | 0..1 | id | 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 | ΣC | 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 | C | 0..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) at-addr-1: If the extension for street name is used then the value for line must not be empty at-addr-2: If the extension for street number is used then the value for line must not be empty at-addr-3: If the extension for floor/door number is used then the value for line must not be empty | ||||
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 | |||||
municipalityCode | 0..1 | string | Address Municipality Code URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/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 (home / work / etc.). 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 | |||||
street | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
streetNumber | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
floorDoorNumber | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
additionalInformation | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/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. may 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 | |||||
AdministrativeGenderAddition | 0..1 | Coding | Administrative Gender Addition URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-gender-administrativeGenderAddition Binding: https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension (required) | |||||
value | 0..1 | code | Primitive value for code | |||||
organization | C | 0..1 | Reference(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: AllLanguages (required): IETF language tag for a human language
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||||
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(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, or Patient/RelatedPerson when using the seealso code | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.extension:citizenship.extension:code.value[x] | extensible | https://termgit.elga.gv.at/ValueSet/elga-laendercodeshttps://termgit.elga.gv.at/ValueSet/elga-laendercodes | |
Patient.identifier:socialSecurityNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:socialSecurityNumber.type | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttps://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | |
Patient.identifier:socialSecurityNumber.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Patient.identifier:bPK.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:bPK.type | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttps://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | |
Patient.identifier:bPK.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Patient.identifier:localPatientId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:localPatientId.type | required | https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttps://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier | |
Patient.name.extension:data-absent-reason.value[x] | required | Pattern: maskedhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Patient.maritalStatus | extensible | MaritalStatusCodeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | |
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.contact.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Patient.contact.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.communication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
at-addr-1 | error | Patient.extension:birthPlace.value[x], Patient.address, Patient.contact.address | If the extension for street name is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) | |
at-addr-2 | error | Patient.extension:birthPlace.value[x], Patient.address, Patient.contact.address | If the extension for street number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) | |
at-addr-3 | error | Patient.extension:birthPlace.value[x], Patient.address, Patient.contact.address | If the extension for floor/door number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) | |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Other representations of profile: CSV, Excel, Schematron