MyHealth@Eu Hospital Discharge Report
0.0.1 - qa-preview
150
MyHealth@Eu Hospital Discharge Report - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2025-05-16 |
Definitions for the Subject logical model.
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Hospital Discharge Report - Hospital Discharge Report subject data element - A.1.1 and A.1.2 eHN |
Short | A.1.1 - Identification and A.1.2 - related contact information of the 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.subjectIdentification | |
Definition | Identification of the patient/subject |
Short | A.1.1 - Identification of the patient/subject |
Control | 1..1 |
Type | Base |
4. Subject.subjectIdentification.given | |
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 | A.1.1.1 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. Subject.subjectIdentification.family | |
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 | A.1.1.2 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. Subject.subjectIdentification.birthDate | |
Definition | Complete date, following the ISO 8601. |
Short | A.1.1.3 - Date of birth |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Subject.subjectIdentification.identifier | |
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for a Czech patient. Multiple identifiers could be provided |
Short | A.1.1.4 - National healthcare patient ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
12. Subject.subjectIdentification.nationality | |
Definition | Nationality of the patient. |
Short | A.1.1.5 - Nationality |
Control | 0..* |
Type | CodeableConcept |
14. Subject.subjectIdentification.gender | |
Definition | This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere in the relevant clinical information section. |
Short | A.1.1.6 - Gender |
Control | 0..1 |
Type | CodeableConcept |
16. Subject.subjectIdentification.countryOfAffiliation | |
Definition | Name of country of affiliation |
Short | A.1.1.7 - Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
18. Subject.subjectContact | |
Definition | Patient/subject related contact information |
Short | A.1.2 - Patient/subject related contact information |
Control | 0..1 |
Type | Base |
20. Subject.subjectContact.personalContact | |
Definition | Patient address |
Short | A.1.2.1 - Patient address |
Control | 0..1 |
Type | Base |
22. Subject.subjectContact.personalContact.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.1.1 - 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.subjectContact.personalContact.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 |
26. Subject.subjectContact.personalContact.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.subjectContact.personalContact.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. Subject.subjectContact.personalContact.address.use | |
Definition | The purpose of this address. |
Short | home | 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())) |
30. Subject.subjectContact.personalContact.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | 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())) |
32. Subject.subjectContact.personalContact.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())) |
34. Subject.subjectContact.personalContact.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())) |
36. Subject.subjectContact.personalContact.address.city | |
Definition | The city where the patient has his/her domicile. The name of the city, town, suburb, village or other community or delivery center. |
Short | A.1.2.1.1.3-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())) |
38. Subject.subjectContact.personalContact.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())) |
40. Subject.subjectContact.personalContact.address.state | |
Definition | The state or province where the patient has his/her domicile. 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 | A.1.2.1.1.5-State or ProvinceSub-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())) |
42. Subject.subjectContact.personalContact.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal 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())) |
44. Subject.subjectContact.personalContact.address.country | |
Definition | The country where the patient has his/her domicile (Country of affiliation). Country - a nation as commonly understood or generally accepted. |
Short | A.1.2.1.1.6-CountryCountry (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())) |
46. Subject.subjectContact.personalContact.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())) |
48. Subject.subjectContact.personalContact.address.street | |
Definition | The street where the patient has his/her domicile. |
Short | A.1.2.1.1.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. Subject.subjectContact.personalContact.address.numberofstreet | |
Definition | The number of the street where the patient has his/her domicile. |
Short | A.1.2.1.1.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. Subject.subjectContact.personalContact.address.postalcode | |
Definition | The postal code where the patient has his/her domicile. |
Short | A.1.2.1.1.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. Subject.subjectContact.personalContact.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.1.2 - Telecom |
Control | 0..* |
Type | ContactPoint |
56. Subject.subjectContact.preferredHP | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 - Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Control | 0..* |
Type | Base |
58. Subject.subjectContact.preferredHP.identifier | |
Definition | An identifier of the health professional that is unique within a defined scope. Example: National health professional ID. Multiple identifiers could be provided. |
Short | A.1.2.2.1 - Identifier of the HP |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
60. Subject.subjectContact.preferredHP.name | |
Definition | Name of the health professional that has been treating or taking responsibility for the patient.[the structure of the name will be the same as for the patient (given name, family name / surname)] |
Short | A.1.2.2.2 - Name of the HP |
Control | 1..1 |
Type | HumanName |
62. Subject.subjectContact.preferredHP.role | |
Definition | Health professional role. Multiple roles could be provided. |
Short | A.1.2.2.3 - Role of the HP |
Control | 0..* |
Type | CodeableConcept |
64. Subject.subjectContact.preferredHP.organization | |
Definition | Health professional organisation |
Short | A.1.2.2.4 - HP Organisation |
Control | 0..1 |
Type | Base |
66. Subject.subjectContact.preferredHP.organization.name | |
Definition | Name of the organization |
Short | A.1.2.2.4.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
68. Subject.subjectContact.preferredHP.organization.address | |
Definition | Address of the organization |
Short | A.1.2.2.4.2-Organization Address |
Control | 0..* |
Type | Address |
70. Subject.subjectContact.preferredHP.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.2.2.4.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
72. Subject.subjectContact.preferredHP.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.2.2.4.4-Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
74. Subject.subjectContact.preferredHP.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.2.5 - Address |
Control | 0..1 |
Type | Address |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. Subject.subjectContact.preferredHP.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 |
78. Subject.subjectContact.preferredHP.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.subjectContact.preferredHP.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
80. Subject.subjectContact.preferredHP.address.use | |
Definition | The purpose of this address. |
Short | home | 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())) |
82. Subject.subjectContact.preferredHP.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | 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())) |
84. Subject.subjectContact.preferredHP.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())) |
86. Subject.subjectContact.preferredHP.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())) |
88. Subject.subjectContact.preferredHP.address.city | |
Definition | The city where the preferred HP has his/her domicile. The name of the city, town, suburb, village or other community or delivery center. |
Short | A.1.2.2.5.3-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())) |
90. Subject.subjectContact.preferredHP.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())) |
92. Subject.subjectContact.preferredHP.address.state | |
Definition | The state or province where the preferred HP has his/her domicile. 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 | A.1.2.2.5.5-State or ProvinceSub-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())) |
94. Subject.subjectContact.preferredHP.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal 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())) |
96. Subject.subjectContact.preferredHP.address.country | |
Definition | The country where the preferred HP has his/her domicile (Country of affiliation). Country - a nation as commonly understood or generally accepted. |
Short | A.1.2.2.5.6-CountryCountry (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())) |
98. Subject.subjectContact.preferredHP.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())) |
100. Subject.subjectContact.preferredHP.address.street | |
Definition | The street where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
102. Subject.subjectContact.preferredHP.address.numberofstreet | |
Definition | The number of the street where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
104. Subject.subjectContact.preferredHP.address.postalcode | |
Definition | The postal code where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
106. Subject.subjectContact.preferredHP.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.2.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
108. Subject.subjectContact.contactPerson | |
Definition | Contact person/ legal guardian (multiple contacts could be provided) |
Short | A.1.2.3 - Contact person/ legal guardian (multiple contacts could be provided) |
Control | 0..* |
Type | Base |
110. Subject.subjectContact.contactPerson.role | |
Definition | Role of the contact person: legal guardian, next of kin, other person to contact. |
Short | A.1.2.3.1 - Role of that person |
Control | 0..* |
Type | CodeableConcept |
112. Subject.subjectContact.contactPerson.relationship | |
Definition | Relationship type with the patient (e.g. father, wife, daughter) |
Short | A.1.2.3.2 - Relationship level |
Control | 0..1 |
Type | CodeableConcept |
114. Subject.subjectContact.contactPerson.given | |
Definition | Given name of the contact person/guardian . This field can contain more than one element. |
Short | A.1.2.3.4 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
116. Subject.subjectContact.contactPerson.family | |
Definition | Family name of the contact person. This field can contain more than one element [the structure of the name will be the same as for the patient (given name, family name / surname)].. |
Short | A.1.2.3.5 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
118. Subject.subjectContact.contactPerson.address | |
Definition | Mailing, home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.3.6 - Address |
Control | 0..* |
Type | Address |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. Subject.subjectContact.contactPerson.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 |
122. Subject.subjectContact.contactPerson.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.subjectContact.contactPerson.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
124. Subject.subjectContact.contactPerson.address.use | |
Definition | The purpose of this address. |
Short | home | 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())) |
126. Subject.subjectContact.contactPerson.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | 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())) |
128. Subject.subjectContact.contactPerson.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())) |
130. Subject.subjectContact.contactPerson.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())) |
132. Subject.subjectContact.contactPerson.address.city | |
Definition | The city where the contact Person has his/her domicile. The name of the city, town, suburb, village or other community or delivery center. |
Short | A.1.2.3.6.3-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())) |
134. Subject.subjectContact.contactPerson.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())) |
136. Subject.subjectContact.contactPerson.address.state | |
Definition | The state or province where the contact Person has his/her domicile. 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 | A.1.2.3.6.5-State or ProvinceSub-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())) |
138. Subject.subjectContact.contactPerson.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal 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())) |
140. Subject.subjectContact.contactPerson.address.country | |
Definition | The country where the contact Person has his/her domicile (Country of affiliation). Country - a nation as commonly understood or generally accepted. |
Short | A.1.2.3.6.6-CountryCountry (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())) |
142. Subject.subjectContact.contactPerson.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())) |
144. Subject.subjectContact.contactPerson.address.street | |
Definition | The street where the contact Person has his/her domicile. |
Short | A.1.2.3.6.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
146. Subject.subjectContact.contactPerson.address.numberofstreet | |
Definition | The number of the street where the contact Person has his/her domicile. |
Short | A.1.2.3.6.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
148. Subject.subjectContact.contactPerson.address.postalcode | |
Definition | The postal code where the contact Person has his/her domicile. |
Short | A.1.2.3.6.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
150. Subject.subjectContact.contactPerson.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.3.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
152. Subject.subjectContact.contactPerson.organization | |
Definition | Contact person organisation information. |
Short | A.1.2.3.8 - Contact person organisation |
Control | 0..1 |
Type | Base |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Hospital Discharge Report - Hospital Discharge Report subject data element - A.1.1 and A.1.2 eHN |
Short | A.1.1 - Identification and A.1.2 - related contact information of the Patient/subject |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Subject.subjectIdentification | |
Definition | Identification of the patient/subject |
Short | A.1.1 - Identification of the patient/subject |
Control | 1..1 |
Type | Base |
4. Subject.subjectIdentification.given | |
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 | A.1.1.1 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. Subject.subjectIdentification.family | |
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 | A.1.1.2 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. Subject.subjectIdentification.birthDate | |
Definition | Complete date, following the ISO 8601. |
Short | A.1.1.3 - Date of birth |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Subject.subjectIdentification.identifier | |
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for a Czech patient. Multiple identifiers could be provided |
Short | A.1.1.4 - National healthcare patient ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
12. Subject.subjectIdentification.nationality | |
Definition | Nationality of the patient. |
Short | A.1.1.5 - Nationality |
Control | 0..* |
Type | CodeableConcept |
14. Subject.subjectIdentification.gender | |
Definition | This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere in the relevant clinical information section. |
Short | A.1.1.6 - Gender |
Control | 0..1 |
Type | CodeableConcept |
16. Subject.subjectIdentification.countryOfAffiliation | |
Definition | Name of country of affiliation |
Short | A.1.1.7 - Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
18. Subject.subjectContact | |
Definition | Patient/subject related contact information |
Short | A.1.2 - Patient/subject related contact information |
Control | 0..1 |
Type | Base |
20. Subject.subjectContact.personalContact | |
Definition | Patient address |
Short | A.1.2.1 - Patient address |
Control | 0..1 |
Type | Base |
22. Subject.subjectContact.personalContact.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.1.1 - Address |
Control | 0..* |
Type | Address |
24. Subject.subjectContact.personalContact.address.street | |
Definition | The street where the patient has his/her domicile. |
Short | A.1.2.1.1.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. Subject.subjectContact.personalContact.address.numberofstreet | |
Definition | The number of the street where the patient has his/her domicile. |
Short | A.1.2.1.1.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. Subject.subjectContact.personalContact.address.city | |
Definition | The city where the patient has his/her domicile. |
Short | A.1.2.1.1.3-City |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. Subject.subjectContact.personalContact.address.postalcode | |
Definition | The postal code where the patient has his/her domicile. |
Short | A.1.2.1.1.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. Subject.subjectContact.personalContact.address.state | |
Definition | The state or province where the patient has his/her domicile. |
Short | A.1.2.1.1.5-State or Province |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. Subject.subjectContact.personalContact.address.country | |
Definition | The country where the patient has his/her domicile (Country of affiliation). |
Short | A.1.2.1.1.6-Country |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. Subject.subjectContact.personalContact.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.1.2 - Telecom |
Control | 0..* |
Type | ContactPoint |
38. Subject.subjectContact.preferredHP | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 - Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Control | 0..* |
Type | Base |
40. Subject.subjectContact.preferredHP.identifier | |
Definition | An identifier of the health professional that is unique within a defined scope. Example: National health professional ID. Multiple identifiers could be provided. |
Short | A.1.2.2.1 - Identifier of the HP |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
42. Subject.subjectContact.preferredHP.name | |
Definition | Name of the health professional that has been treating or taking responsibility for the patient.[the structure of the name will be the same as for the patient (given name, family name / surname)] |
Short | A.1.2.2.2 - Name of the HP |
Control | 1..1 |
Type | HumanName |
44. Subject.subjectContact.preferredHP.role | |
Definition | Health professional role. Multiple roles could be provided. |
Short | A.1.2.2.3 - Role of the HP |
Control | 0..* |
Type | CodeableConcept |
46. Subject.subjectContact.preferredHP.organization | |
Definition | Health professional organisation |
Short | A.1.2.2.4 - HP Organisation |
Control | 0..1 |
Type | Base |
48. Subject.subjectContact.preferredHP.organization.name | |
Definition | Name of the organization |
Short | A.1.2.2.4.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. Subject.subjectContact.preferredHP.organization.address | |
Definition | Address of the organization |
Short | A.1.2.2.4.2-Organization Address |
Control | 0..* |
Type | Address |
52. Subject.subjectContact.preferredHP.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.2.2.4.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
54. Subject.subjectContact.preferredHP.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.2.2.4.4-Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
56. Subject.subjectContact.preferredHP.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.2.5 - Address |
Control | 0..1 |
Type | Address |
58. Subject.subjectContact.preferredHP.address.street | |
Definition | The street where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. Subject.subjectContact.preferredHP.address.numberofstreet | |
Definition | The number of the street where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. Subject.subjectContact.preferredHP.address.city | |
Definition | The city where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.3-City |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. Subject.subjectContact.preferredHP.address.postalcode | |
Definition | The postal code where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
66. Subject.subjectContact.preferredHP.address.state | |
Definition | The state or province where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.5-State or Province |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
68. Subject.subjectContact.preferredHP.address.country | |
Definition | The country where the preferred HP has his/her domicile (Country of affiliation). |
Short | A.1.2.2.5.6-Country |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
70. Subject.subjectContact.preferredHP.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.2.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
72. Subject.subjectContact.contactPerson | |
Definition | Contact person/ legal guardian (multiple contacts could be provided) |
Short | A.1.2.3 - Contact person/ legal guardian (multiple contacts could be provided) |
Control | 0..* |
Type | Base |
74. Subject.subjectContact.contactPerson.role | |
Definition | Role of the contact person: legal guardian, next of kin, other person to contact. |
Short | A.1.2.3.1 - Role of that person |
Control | 0..* |
Type | CodeableConcept |
76. Subject.subjectContact.contactPerson.relationship | |
Definition | Relationship type with the patient (e.g. father, wife, daughter) |
Short | A.1.2.3.2 - Relationship level |
Control | 0..1 |
Type | CodeableConcept |
78. Subject.subjectContact.contactPerson.given | |
Definition | Given name of the contact person/guardian . This field can contain more than one element. |
Short | A.1.2.3.4 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
80. Subject.subjectContact.contactPerson.family | |
Definition | Family name of the contact person. This field can contain more than one element [the structure of the name will be the same as for the patient (given name, family name / surname)].. |
Short | A.1.2.3.5 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
82. Subject.subjectContact.contactPerson.address | |
Definition | Mailing, home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.3.6 - Address |
Control | 0..* |
Type | Address |
84. Subject.subjectContact.contactPerson.address.street | |
Definition | The street where the contact Person has his/her domicile. |
Short | A.1.2.3.6.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
86. Subject.subjectContact.contactPerson.address.numberofstreet | |
Definition | The number of the street where the contact Person has his/her domicile. |
Short | A.1.2.3.6.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
88. Subject.subjectContact.contactPerson.address.city | |
Definition | The city where the contact Person has his/her domicile. |
Short | A.1.2.3.6.3-City |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
90. Subject.subjectContact.contactPerson.address.postalcode | |
Definition | The postal code where the contact Person has his/her domicile. |
Short | A.1.2.3.6.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
92. Subject.subjectContact.contactPerson.address.state | |
Definition | The state or province where the contact Person has his/her domicile. |
Short | A.1.2.3.6.5-State or Province |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
94. Subject.subjectContact.contactPerson.address.country | |
Definition | The country where the contact Person has his/her domicile (Country of affiliation). |
Short | A.1.2.3.6.6-Country |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
96. Subject.subjectContact.contactPerson.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.3.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
98. Subject.subjectContact.contactPerson.organization | |
Definition | Contact person organisation information. |
Short | A.1.2.3.8 - Contact person organisation |
Control | 0..1 |
Type | Base |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Hospital Discharge Report - Hospital Discharge Report subject data element - A.1.1 and A.1.2 eHN |
Short | A.1.1 - Identification and A.1.2 - related contact information of the 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.subjectIdentification | |
Definition | Identification of the patient/subject |
Short | A.1.1 - Identification of the patient/subject |
Control | 1..1 |
Type | Base |
4. Subject.subjectIdentification.given | |
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 | A.1.1.1 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. Subject.subjectIdentification.family | |
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 | A.1.1.2 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. Subject.subjectIdentification.birthDate | |
Definition | Complete date, following the ISO 8601. |
Short | A.1.1.3 - Date of birth |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Subject.subjectIdentification.identifier | |
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for a Czech patient. Multiple identifiers could be provided |
Short | A.1.1.4 - National healthcare patient ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
12. Subject.subjectIdentification.nationality | |
Definition | Nationality of the patient. |
Short | A.1.1.5 - Nationality |
Control | 0..* |
Type | CodeableConcept |
14. Subject.subjectIdentification.gender | |
Definition | This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere in the relevant clinical information section. |
Short | A.1.1.6 - Gender |
Control | 0..1 |
Type | CodeableConcept |
16. Subject.subjectIdentification.countryOfAffiliation | |
Definition | Name of country of affiliation |
Short | A.1.1.7 - Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
18. Subject.subjectContact | |
Definition | Patient/subject related contact information |
Short | A.1.2 - Patient/subject related contact information |
Control | 0..1 |
Type | Base |
20. Subject.subjectContact.personalContact | |
Definition | Patient address |
Short | A.1.2.1 - Patient address |
Control | 0..1 |
Type | Base |
22. Subject.subjectContact.personalContact.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.1.1 - 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.subjectContact.personalContact.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 |
26. Subject.subjectContact.personalContact.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.subjectContact.personalContact.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. Subject.subjectContact.personalContact.address.use | |
Definition | The purpose of this address. |
Short | home | 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 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()) ) |
30. Subject.subjectContact.personalContact.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | 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). |
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()) ) |
32. Subject.subjectContact.personalContact.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()) ) |
34. Subject.subjectContact.personalContact.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()) ) |
36. Subject.subjectContact.personalContact.address.city | |
Definition | The city where the patient has his/her domicile. |
Short | A.1.2.1.1.3-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()) ) |
38. Subject.subjectContact.personalContact.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()) ) |
40. Subject.subjectContact.personalContact.address.state | |
Definition | The state or province where the patient has his/her domicile. |
Short | A.1.2.1.1.5-State or Province |
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()) ) |
42. Subject.subjectContact.personalContact.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal 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()) ) |
44. Subject.subjectContact.personalContact.address.country | |
Definition | The country where the patient has his/her domicile (Country of affiliation). |
Short | A.1.2.1.1.6-Country |
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()) ) |
46. Subject.subjectContact.personalContact.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()) ) |
48. Subject.subjectContact.personalContact.address.street | |
Definition | The street where the patient has his/her domicile. |
Short | A.1.2.1.1.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. Subject.subjectContact.personalContact.address.numberofstreet | |
Definition | The number of the street where the patient has his/her domicile. |
Short | A.1.2.1.1.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. Subject.subjectContact.personalContact.address.postalcode | |
Definition | The postal code where the patient has his/her domicile. |
Short | A.1.2.1.1.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. Subject.subjectContact.personalContact.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.1.2 - Telecom |
Control | 0..* |
Type | ContactPoint |
56. Subject.subjectContact.preferredHP | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 - Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Control | 0..* |
Type | Base |
58. Subject.subjectContact.preferredHP.identifier | |
Definition | An identifier of the health professional that is unique within a defined scope. Example: National health professional ID. Multiple identifiers could be provided. |
Short | A.1.2.2.1 - Identifier of the HP |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
60. Subject.subjectContact.preferredHP.name | |
Definition | Name of the health professional that has been treating or taking responsibility for the patient.[the structure of the name will be the same as for the patient (given name, family name / surname)] |
Short | A.1.2.2.2 - Name of the HP |
Control | 1..1 |
Type | HumanName |
62. Subject.subjectContact.preferredHP.role | |
Definition | Health professional role. Multiple roles could be provided. |
Short | A.1.2.2.3 - Role of the HP |
Control | 0..* |
Type | CodeableConcept |
64. Subject.subjectContact.preferredHP.organization | |
Definition | Health professional organisation |
Short | A.1.2.2.4 - HP Organisation |
Control | 0..1 |
Type | Base |
66. Subject.subjectContact.preferredHP.organization.name | |
Definition | Name of the organization |
Short | A.1.2.2.4.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
68. Subject.subjectContact.preferredHP.organization.address | |
Definition | Address of the organization |
Short | A.1.2.2.4.2-Organization Address |
Control | 0..* |
Type | Address |
70. Subject.subjectContact.preferredHP.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.2.2.4.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
72. Subject.subjectContact.preferredHP.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.2.2.4.4-Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
74. Subject.subjectContact.preferredHP.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.2.5 - Address |
Control | 0..1 |
Type | Address |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. Subject.subjectContact.preferredHP.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 |
78. Subject.subjectContact.preferredHP.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.subjectContact.preferredHP.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
80. Subject.subjectContact.preferredHP.address.use | |
Definition | The purpose of this address. |
Short | home | 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 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()) ) |
82. Subject.subjectContact.preferredHP.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | 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). |
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()) ) |
84. Subject.subjectContact.preferredHP.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()) ) |
86. Subject.subjectContact.preferredHP.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()) ) |
88. Subject.subjectContact.preferredHP.address.city | |
Definition | The city where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.3-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()) ) |
90. Subject.subjectContact.preferredHP.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()) ) |
92. Subject.subjectContact.preferredHP.address.state | |
Definition | The state or province where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.5-State or Province |
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()) ) |
94. Subject.subjectContact.preferredHP.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal 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()) ) |
96. Subject.subjectContact.preferredHP.address.country | |
Definition | The country where the preferred HP has his/her domicile (Country of affiliation). |
Short | A.1.2.2.5.6-Country |
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()) ) |
98. Subject.subjectContact.preferredHP.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()) ) |
100. Subject.subjectContact.preferredHP.address.street | |
Definition | The street where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
102. Subject.subjectContact.preferredHP.address.numberofstreet | |
Definition | The number of the street where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
104. Subject.subjectContact.preferredHP.address.postalcode | |
Definition | The postal code where the preferred HP has his/her domicile. |
Short | A.1.2.2.5.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
106. Subject.subjectContact.preferredHP.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.2.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
108. Subject.subjectContact.contactPerson | |
Definition | Contact person/ legal guardian (multiple contacts could be provided) |
Short | A.1.2.3 - Contact person/ legal guardian (multiple contacts could be provided) |
Control | 0..* |
Type | Base |
110. Subject.subjectContact.contactPerson.role | |
Definition | Role of the contact person: legal guardian, next of kin, other person to contact. |
Short | A.1.2.3.1 - Role of that person |
Control | 0..* |
Type | CodeableConcept |
112. Subject.subjectContact.contactPerson.relationship | |
Definition | Relationship type with the patient (e.g. father, wife, daughter) |
Short | A.1.2.3.2 - Relationship level |
Control | 0..1 |
Type | CodeableConcept |
114. Subject.subjectContact.contactPerson.given | |
Definition | Given name of the contact person/guardian . This field can contain more than one element. |
Short | A.1.2.3.4 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
116. Subject.subjectContact.contactPerson.family | |
Definition | Family name of the contact person. This field can contain more than one element [the structure of the name will be the same as for the patient (given name, family name / surname)].. |
Short | A.1.2.3.5 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
118. Subject.subjectContact.contactPerson.address | |
Definition | Mailing, home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, 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. |
Short | A.1.2.3.6 - Address |
Control | 0..* |
Type | Address |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. Subject.subjectContact.contactPerson.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 |
122. Subject.subjectContact.contactPerson.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.subjectContact.contactPerson.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
124. Subject.subjectContact.contactPerson.address.use | |
Definition | The purpose of this address. |
Short | home | 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 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()) ) |
126. Subject.subjectContact.contactPerson.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | 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). |
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()) ) |
128. Subject.subjectContact.contactPerson.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()) ) |
130. Subject.subjectContact.contactPerson.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()) ) |
132. Subject.subjectContact.contactPerson.address.city | |
Definition | The city where the contact Person has his/her domicile. |
Short | A.1.2.3.6.3-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()) ) |
134. Subject.subjectContact.contactPerson.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()) ) |
136. Subject.subjectContact.contactPerson.address.state | |
Definition | The state or province where the contact Person has his/her domicile. |
Short | A.1.2.3.6.5-State or Province |
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()) ) |
138. Subject.subjectContact.contactPerson.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal 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()) ) |
140. Subject.subjectContact.contactPerson.address.country | |
Definition | The country where the contact Person has his/her domicile (Country of affiliation). |
Short | A.1.2.3.6.6-Country |
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()) ) |
142. Subject.subjectContact.contactPerson.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()) ) |
144. Subject.subjectContact.contactPerson.address.street | |
Definition | The street where the contact Person has his/her domicile. |
Short | A.1.2.3.6.1- Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
146. Subject.subjectContact.contactPerson.address.numberofstreet | |
Definition | The number of the street where the contact Person has his/her domicile. |
Short | A.1.2.3.6.2-Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
148. Subject.subjectContact.contactPerson.address.postalcode | |
Definition | The postal code where the contact Person has his/her domicile. |
Short | A.1.2.3.6.4-Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
150. Subject.subjectContact.contactPerson.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.3.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
152. Subject.subjectContact.contactPerson.organization | |
Definition | Contact person organisation information. |
Short | A.1.2.3.8 - Contact person organisation |
Control | 0..1 |
Type | Base |