TestIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Extension: Patient Contact Details
| Official URL: http://example.org/StructureDefinition/patient-contact-details | Version: 0.1.0 | |||
| Draft as of 2025-04-11 | Computable Name: PatientContactDetails | |||
Details about a patient's contact information. This extension is used on the Patient resource.
Context of Use
-
Element ID:
Patient
This extension may be used on the following element(s):
Usage info
Usage:
- This Extension is not used by any profiles in this Implementation Guide
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension |
0..* | Extension | Patient Contact Details | |
  extension |
1..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:homeAddress |
S | 1..1 | Extension | Home Address |
  extension |
0..0 | |||
| url |
1..1 | uri | "homeAddress" | |
  value[x] |
0..1 | Address | Value of extension | |
| extension:homePhone |
S | 0..1 | Extension | Home Phone Number |
| extension |
0..0 | |||
| url |
1..1 | uri | "homePhone" | |
 value[x] |
0..1 | ContactPoint | Value of extension | |
  system |
0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
 extension:homeEmail |
S | 0..1 | Extension | Home Email Address |
| extension |
0..0 | |||
| url |
1..1 | uri | "homeEmail" | |
| value[x] |
0..1 | ContactPoint | Value of extension | |
| system |
0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| url |
1..1 | uri | "http://example.org/StructureDefinition/patient-contact-details" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Patient Contact Details | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:homeAddress |
S | 1..1 | Extension | Home Address |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "homeAddress" | |
| value[x] |
0..1 | Address | Value of extension | |
| extension:homePhone |
S | 0..1 | Extension | Home Phone Number |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "homePhone" | |
| value[x] |
0..1 | ContactPoint | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
| value |
Σ | 0..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| extension:homeEmail |
S | 0..1 | Extension | Home Email Address |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "homeEmail" | |
| value[x] |
0..1 | ContactPoint | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
| value |
Σ | 0..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| url |
1..1 | uri | "http://example.org/StructureDefinition/patient-contact-details" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: Details about a patient's contact information. This extension is used on the Patient resource.
- homeAddress: Address: The home address of the patient.
- homePhone: ContactPoint: The home phone number of the patient.
- homeEmail: ContactPoint: The home email address of the patient.
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Patient Contact Details | |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:homeAddress |
S | 1..1 | Extension | Home Address |
| extension |
0..0 | |||
| url |
1..1 | uri | "homeAddress" | |
| value[x] |
0..1 | Address | Value of extension | |
| extension:homePhone |
S | 0..1 | Extension | Home Phone Number |
| extension |
0..0 | |||
| url |
1..1 | uri | "homePhone" | |
| value[x] |
0..1 | ContactPoint | Value of extension | |
| system |
0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
| extension:homeEmail |
S | 0..1 | Extension | Home Email Address |
| extension |
0..0 | |||
| url |
1..1 | uri | "homeEmail" | |
| value[x] |
0..1 | ContactPoint | Value of extension | |
| system |
0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| url |
1..1 | uri | "http://example.org/StructureDefinition/patient-contact-details" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Patient Contact Details | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:homeAddress |
S | 1..1 | Extension | Home Address |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "homeAddress" | |
| value[x] |
0..1 | Address | Value of extension | |
| extension:homePhone |
S | 0..1 | Extension | Home Phone Number |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "homePhone" | |
| value[x] |
0..1 | ContactPoint | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
| value |
Σ | 0..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| extension:homeEmail |
S | 0..1 | Extension | Home Email Address |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "homeEmail" | |
| value[x] |
0..1 | ContactPoint | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
| value |
Σ | 0..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| url |
1..1 | uri | "http://example.org/StructureDefinition/patient-contact-details" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: Details about a patient's contact information. This extension is used on the Patient resource.
- homeAddress: Address: The home address of the patient.
- homePhone: ContactPoint: The home phone number of the patient.
- homeEmail: ContactPoint: The home email address of the patient.
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Extension.extension:homePhone.value[x].system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Extension.extension:homePhone.value[x].use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Extension.extension:homeEmail.value[x].system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Extension.extension:homeEmail.value[x].use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |