MyHealth@Eu Laboratory Report
0.0.1 - qa-preview
150
This page is part of the MyHealth@Eu Laboratory Report (v0.0.1: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Draft as of 2024-04-18 |
Definitions for the Subject logical model.
Guidance on how to interpret the contents of this table can be found here
0. Subject | |||||
Definition | Identification of the patient/subject and Patient/subject related contact information as defined by the MyHealth@EU business requirement '13.01 Create the MyHealth@EU Laboratory Result Report Content'. | ||||
Short | Patient/subject | ||||
Logical Model | Instances of this logical model are not marked to be the target of a Reference | ||||
2. Subject.identification | |||||
Definition | Identification of the patient/subject | ||||
Short | Identification of the patient/subject | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Obligations |
| ||||
4. Subject.identification.familyName | |||||
Definition | The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present. | ||||
Short | Family name/surname | ||||
Control | 1..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
6. Subject.identification.givenName | |||||
Definition | The given name/first name of the patient (also known as forename or first name). This field can contain more than one element. | ||||
Short | Given name | ||||
Control | 1..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
8. Subject.identification.dateOfBirth | |||||
Definition | The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601 | ||||
Short | Date of birth | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
10. Subject.identification.identifier | |||||
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided. | ||||
Short | Personal identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Obligations |
| ||||
12. Subject.identification.gender | |||||
Definition | This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender | ||||
Short | Gender | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
Obligations |
| ||||
14. Subject.identification.sex | |||||
Definition | Sex for clinical use | ||||
Short | Sex for clinical use | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
16. Subject.addressTelecom | |||||
Definition | Patient/subject related contact information | ||||
Short | Patient/subject related contact information | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
18. Subject.addressTelecom.address | |||||
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166 | ||||
Short | Address | ||||
Control | 0..* | ||||
Type | Address | ||||
20. Subject.addressTelecom.address.street | |||||
Definition | The street where the patient has his/her domicile. Example: Oxford | ||||
Short | Street | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
22. Subject.addressTelecom.address.houseNumber | |||||
Definition | The house number of the patient | ||||
Short | House Number | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
24. Subject.addressTelecom.address.postBox | |||||
Definition | Letter box for the patient | ||||
Short | Post Box | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
26. Subject.addressTelecom.address.postalCode | |||||
Definition | The postal code where the patient has his/her domicile. Example: W1W 8LG | ||||
Short | Postal Code | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
28. Subject.addressTelecom.address.stateOrProvince | |||||
Definition | The state or province where the patient has his/her domicile. Example: London | ||||
Short | State or Province | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
30. Subject.addressTelecom.address.city | |||||
Definition | The city where the patient has his/her domicile. Example: London | ||||
Short | City | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
32. Subject.addressTelecom.address.countryCode | |||||
Definition | The country where the patient has his/her domicile (Country of affiliation). Example: UK | ||||
Short | Country Code | ||||
Control | 1..1 | ||||
Type | CodeableConcept | ||||
Obligations |
| ||||
34. Subject.addressTelecom.address.use | |||||
Definition | home | work | temp | old | billing - purpose of this address | ||||
Short | Use of Address | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
36. Subject.addressTelecom.address.type | |||||
Definition | postal | physical | both | ||||
Short | Type of address | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
38. Subject.addressTelecom.telecom | |||||
Definition | Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s): | ||||
Short | Telecom | ||||
Control | 0..* | ||||
Type | ContactPoint |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |||||
Definition | Identification of the patient/subject and Patient/subject related contact information as defined by the MyHealth@EU business requirement '13.01 Create the MyHealth@EU Laboratory Result Report Content'. | ||||
Short | Patient/subject | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Logical Model | Instances of this logical model are not marked to be the target of a Reference | ||||
2. Subject.identification | |||||
Definition | Identification of the patient/subject | ||||
Short | Identification of the patient/subject | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Obligations |
| ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
4. Subject.identification.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
6. Subject.identification.familyName | |||||
Definition | The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present. | ||||
Short | Family name/surname | ||||
Control | 1..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
8. Subject.identification.givenName | |||||
Definition | The given name/first name of the patient (also known as forename or first name). This field can contain more than one element. | ||||
Short | Given name | ||||
Control | 1..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
10. Subject.identification.dateOfBirth | |||||
Definition | The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601 | ||||
Short | Date of birth | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
12. Subject.identification.identifier | |||||
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided. | ||||
Short | Personal identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Obligations |
| ||||
14. Subject.identification.gender | |||||
Definition | This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender | ||||
Short | Gender | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
Obligations |
| ||||
16. Subject.identification.sex | |||||
Definition | Sex for clinical use | ||||
Short | Sex for clinical use | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
18. Subject.addressTelecom | |||||
Definition | Patient/subject related contact information | ||||
Short | Patient/subject related contact information | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. Subject.addressTelecom.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
22. Subject.addressTelecom.address | |||||
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166 | ||||
Short | Address | ||||
Control | 0..* | ||||
Type | Address | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. Subject.addressTelecom.address.use | |||||
Definition | home | work | temp | old | billing - purpose of this address The purpose of this address. | ||||
Short | Use of Addresshome | work | temp | old | billing - purpose of this address | ||||
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1 )The use of an address. | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
Example | <br/><b>General</b>:home | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
26. Subject.addressTelecom.address.type | |||||
Definition | postal | physical | both Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | ||||
Short | Type of addresspostal | physical | both | ||||
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1 )The type of an address (physical / postal). | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:both | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
28. Subject.addressTelecom.address.city | |||||
Definition | The city where the patient has his/her domicile. Example: London The name of the city, town, suburb, village or other community or delivery center. | ||||
Short | CityName of city, town etc. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | Municpality | ||||
Example | <br/><b>General</b>:Erewhon | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
30. Subject.addressTelecom.address.postalCode | |||||
Definition | The postal code where the patient has his/her domicile. Example: W1W 8LG A postal code designating a region defined by the postal service. | ||||
Short | Postal CodePostal code for area | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | Zip | ||||
Example | <br/><b>General</b>:9132 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
32. Subject.addressTelecom.address.street | |||||
Definition | The street where the patient has his/her domicile. Example: Oxford | ||||
Short | Street | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
34. Subject.addressTelecom.address.houseNumber | |||||
Definition | The house number of the patient | ||||
Short | House Number | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
36. Subject.addressTelecom.address.postBox | |||||
Definition | Letter box for the patient | ||||
Short | Post Box | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
38. Subject.addressTelecom.address.stateOrProvince | |||||
Definition | The state or province where the patient has his/her domicile. Example: London | ||||
Short | State or Province | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
40. Subject.addressTelecom.address.countryCode | |||||
Definition | The country where the patient has his/her domicile (Country of affiliation). Example: UK | ||||
Short | Country Code | ||||
Control | 1..1 | ||||
Type | CodeableConcept | ||||
Obligations |
| ||||
42. Subject.addressTelecom.telecom | |||||
Definition | Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s): | ||||
Short | Telecom | ||||
Control | 0..* | ||||
Type | ContactPoint |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |||||
Definition | Identification of the patient/subject and Patient/subject related contact information as defined by the MyHealth@EU business requirement '13.01 Create the MyHealth@EU Laboratory Result Report Content'. | ||||
Short | Patient/subject | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Logical Model | Instances of this logical model are not marked to be the target of a Reference | ||||
2. Subject.identification | |||||
Definition | Identification of the patient/subject | ||||
Short | Identification of the patient/subject | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Obligations |
| ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
4. Subject.identification.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
6. Subject.identification.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Subject.identification.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
8. Subject.identification.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
10. Subject.identification.familyName | |||||
Definition | The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present. | ||||
Short | Family name/surname | ||||
Control | 1..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
12. Subject.identification.givenName | |||||
Definition | The given name/first name of the patient (also known as forename or first name). This field can contain more than one element. | ||||
Short | Given name | ||||
Control | 1..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
14. Subject.identification.dateOfBirth | |||||
Definition | The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601 | ||||
Short | Date of birth | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
16. Subject.identification.identifier | |||||
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided. | ||||
Short | Personal identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Obligations |
| ||||
18. Subject.identification.gender | |||||
Definition | This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender | ||||
Short | Gender | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
Obligations |
| ||||
20. Subject.identification.sex | |||||
Definition | Sex for clinical use | ||||
Short | Sex for clinical use | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
22. Subject.addressTelecom | |||||
Definition | Patient/subject related contact information | ||||
Short | Patient/subject related contact information | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. Subject.addressTelecom.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
26. Subject.addressTelecom.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Subject.addressTelecom.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
28. Subject.addressTelecom.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
30. Subject.addressTelecom.address | |||||
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166 | ||||
Short | Address | ||||
Control | 0..* | ||||
Type | Address | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. Subject.addressTelecom.address.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
34. Subject.addressTelecom.address.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Subject.addressTelecom.address.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
36. Subject.addressTelecom.address.use | |||||
Definition | home | work | temp | old | billing - purpose of this address | ||||
Short | Use of Address | ||||
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1 )The use of an address. | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
Example | <br/><b>General</b>:home | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. Subject.addressTelecom.address.type | |||||
Definition | postal | physical | both | ||||
Short | Type of address | ||||
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1 )The type of an address (physical / postal). | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:both | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. Subject.addressTelecom.address.text | |||||
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | ||||
Short | Text representation of the address | ||||
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | A renderable, unencoded form. | ||||
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. Subject.addressTelecom.address.line | |||||
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | ||||
Short | Street name, number, direction & P.O. Box etc. | ||||
Control | 0..* | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:137 Nowhere Street | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. Subject.addressTelecom.address.city | |||||
Definition | The city where the patient has his/her domicile. Example: London | ||||
Short | City | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | Municpality | ||||
Example | <br/><b>General</b>:Erewhon | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. Subject.addressTelecom.address.district | |||||
Definition | The name of the administrative area (county). | ||||
Short | District name (aka county) | ||||
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | County | ||||
Example | <br/><b>General</b>:Madison | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. Subject.addressTelecom.address.state | |||||
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). | ||||
Short | Sub-unit of country (abbreviations ok) | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | Province, Territory | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. Subject.addressTelecom.address.postalCode | |||||
Definition | The postal code where the patient has his/her domicile. Example: W1W 8LG | ||||
Short | Postal Code | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | Zip | ||||
Example | <br/><b>General</b>:9132 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. Subject.addressTelecom.address.country | |||||
Definition | Country - a nation as commonly understood or generally accepted. | ||||
Short | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. Subject.addressTelecom.address.period | |||||
Definition | Time period when address was/is in use. | ||||
Short | Time period when address was/is in use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows addresses to be placed in historical context. | ||||
Example | <br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" } | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. Subject.addressTelecom.address.street | |||||
Definition | The street where the patient has his/her domicile. Example: Oxford | ||||
Short | Street | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
58. Subject.addressTelecom.address.houseNumber | |||||
Definition | The house number of the patient | ||||
Short | House Number | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
60. Subject.addressTelecom.address.postBox | |||||
Definition | Letter box for the patient | ||||
Short | Post Box | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
62. Subject.addressTelecom.address.stateOrProvince | |||||
Definition | The state or province where the patient has his/her domicile. Example: London | ||||
Short | State or Province | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
64. Subject.addressTelecom.address.countryCode | |||||
Definition | The country where the patient has his/her domicile (Country of affiliation). Example: UK | ||||
Short | Country Code | ||||
Control | 1..1 | ||||
Type | CodeableConcept | ||||
Obligations |
| ||||
66. Subject.addressTelecom.telecom | |||||
Definition | Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s): | ||||
Short | Telecom | ||||
Control | 0..* | ||||
Type | ContactPoint |