Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions
Resource Profile: UAPI RelatedPerson
| Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-relatedPerson | Version: 1.1.19 | |||
| Active as of 2021-06-04 | Responsible: Genentech USIX PE |
Realm: 
|
Computable Name: UapiRelatedPerson | |
This profile constrains the Related Person resource to be included in UAPI data exchanges
Usage:
- Use this Resource Profile: UAPI Bundle - AS Enrollment, UAPI Bundle - Copay Request-Response
- Refer to this Resource Profile: UAPI Bundle - AS Enrollment, UAPI Bundle - Copay Request-Response
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
  patient | 1..1 | Reference(UAPI Patient) | The patient this person is related to | |
   reference | 0..1 | string | Patient resource UUID | |
 type | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| relationship | 1..1 | CodeableConcept | The nature of the relationship | |
 coding | 1..1 | Coding | Code defined by a terminology system | |
 system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| name | 1..1 | HumanName | A name associated with the person | |
| use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| family | 1..1 | string | Up to 255 Characters | |
| given | 1..1 | string | Up to 255 Characters | |
 Slices for telecom | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | |
 telecom:All Slices | Content/Rules for all slices | |||
  system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 1..1 | string | The actual contact point details | |
 use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
 telecom:Phone | 1..* | ContactPoint | A contact detail for the person | |
 system | 0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
 value | 0..1 | string | Phone (10 digit numeric values only) | |
 telecom:Email | 0..* | ContactPoint | A contact detail for the person | |
| system | 0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| photo | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
| patient | Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to |
| reference | ΣC | 0..1 | string | Patient resource UUID |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient |
 relationship | Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| name | Σ | 1..1 | HumanName | A name associated with the person |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official |
| family | Σ | 1..1 | string | Up to 255 Characters |
| given | Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name |
| Slices for telecom | Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system |
| telecom:All Slices | Content/Rules for all slices | |||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | Σ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:Phone | Σ | 1..* | ContactPoint | A contact detail for the person |
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone |
| value | Σ | 0..1 | string | Phone (10 digit numeric values only) |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:Email | Σ | 0..* | ContactPoint | A contact detail for the person |
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: email |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| RelatedPerson.patient.type | extensible | Pattern: Patient |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
| RelatedPerson.name.use | required | Pattern: official |
| RelatedPerson.telecom.system | required | ContactPointSystem |
| RelatedPerson.telecom.use | required | ContactPointUse |
| RelatedPerson.telecom:Phone.system | required | Pattern: phone |
| RelatedPerson.telecom:Phone.use | required | ContactPointUse |
| RelatedPerson.telecom:Email.system | required | Pattern: email |
| RelatedPerson.telecom:Email.use | required | ContactPointUse |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient | Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Patient resource UUID | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| relationship | Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | Σ | 1..1 | HumanName | A name associated with the person | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 1..1 | string | Up to 255 Characters | ||||
| given | Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | ||||
| telecom:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
| value | Σ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| 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 | ||||
| telecom:Phone | Σ | 1..* | ContactPoint | A contact detail for the person | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone | ||||
| value | Σ | 0..1 | string | Phone (10 digit numeric values only) | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| 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 | ||||
| telecom:Email | Σ | 0..* | ContactPoint | A contact detail for the person | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the related person was born | ||||
| address | Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
| period | 0..1 | Period | Period of time that this relationship is considered valid | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): IETF language tag
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.patient.type | extensible | Pattern: Patient | ||||
| RelatedPerson.relationship | preferred | PatientRelationshipType | ||||
| RelatedPerson.name.use | required | Pattern: official | ||||
| RelatedPerson.telecom.system | required | ContactPointSystem | ||||
| RelatedPerson.telecom.use | required | ContactPointUse | ||||
| RelatedPerson.telecom:Phone.system | required | Pattern: phone | ||||
| RelatedPerson.telecom:Phone.use | required | ContactPointUse | ||||
| RelatedPerson.telecom:Email.system | required | Pattern: email | ||||
| RelatedPerson.telecom:Email.use | required | ContactPointUse | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
This structure is derived from RelatedPerson
Summary
Mandatory: 13 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element RelatedPerson.telecom is sliced based on the value of value:system (Closed)
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| patient | 1..1 | Reference(UAPI Patient) | The patient this person is related to | |
| reference | 0..1 | string | Patient resource UUID | |
| type | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| relationship | 1..1 | CodeableConcept | The nature of the relationship | |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| name | 1..1 | HumanName | A name associated with the person | |
| use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| family | 1..1 | string | Up to 255 Characters | |
| given | 1..1 | string | Up to 255 Characters | |
| Slices for telecom | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | |
| telecom:All Slices | Content/Rules for all slices | |||
| system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 1..1 | string | The actual contact point details | |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
| telecom:Phone | 1..* | ContactPoint | A contact detail for the person | |
| system | 0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
| value | 0..1 | string | Phone (10 digit numeric values only) | |
| telecom:Email | 0..* | ContactPoint | A contact detail for the person | |
| system | 0..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| photo | 0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
| patient | Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to |
| reference | ΣC | 0..1 | string | Patient resource UUID |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient |
| relationship | Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| name | Σ | 1..1 | HumanName | A name associated with the person |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official |
| family | Σ | 1..1 | string | Up to 255 Characters |
| given | Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name |
| Slices for telecom | Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system |
| telecom:All Slices | Content/Rules for all slices | |||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | Σ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:Phone | Σ | 1..* | ContactPoint | A contact detail for the person |
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone |
| value | Σ | 0..1 | string | Phone (10 digit numeric values only) |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:Email | Σ | 0..* | ContactPoint | A contact detail for the person |
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: email |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| RelatedPerson.patient.type | extensible | Pattern: Patient |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
| RelatedPerson.name.use | required | Pattern: official |
| RelatedPerson.telecom.system | required | ContactPointSystem |
| RelatedPerson.telecom.use | required | ContactPointUse |
| RelatedPerson.telecom:Phone.system | required | Pattern: phone |
| RelatedPerson.telecom:Phone.use | required | ContactPointUse |
| RelatedPerson.telecom:Email.system | required | Pattern: email |
| RelatedPerson.telecom:Email.use | required | ContactPointUse |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient | Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Patient resource UUID | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| relationship | Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | Σ | 1..1 | HumanName | A name associated with the person | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 1..1 | string | Up to 255 Characters | ||||
| given | Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | ||||
| telecom:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
| value | Σ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| 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 | ||||
| telecom:Phone | Σ | 1..* | ContactPoint | A contact detail for the person | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone | ||||
| value | Σ | 0..1 | string | Phone (10 digit numeric values only) | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| 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 | ||||
| telecom:Email | Σ | 0..* | ContactPoint | A contact detail for the person | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the related person was born | ||||
| address | Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
| period | 0..1 | Period | Period of time that this relationship is considered valid | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): IETF language tag
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.patient.type | extensible | Pattern: Patient | ||||
| RelatedPerson.relationship | preferred | PatientRelationshipType | ||||
| RelatedPerson.name.use | required | Pattern: official | ||||
| RelatedPerson.telecom.system | required | ContactPointSystem | ||||
| RelatedPerson.telecom.use | required | ContactPointUse | ||||
| RelatedPerson.telecom:Phone.system | required | Pattern: phone | ||||
| RelatedPerson.telecom:Phone.use | required | ContactPointUse | ||||
| RelatedPerson.telecom:Email.system | required | Pattern: email | ||||
| RelatedPerson.telecom:Email.use | required | ContactPointUse | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
This structure is derived from RelatedPerson
Summary
Mandatory: 13 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element RelatedPerson.telecom is sliced based on the value of value:system (Closed)
Other representations of profile: CSV, Excel, Schematron