Universal API Implementation Guide
1.1.20 - ci-build
Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-relatedPerson | Version: 1.1.20 | |||
Active as of 2021-06-04 | Computable Name: UapiRelatedPerson |
This profile constrains the Related Person resource to be included in UAPI data exchanges
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() ![]() |
Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Patient resource UUID |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
Σ | 1..1 | HumanName | A name associated with the person |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Phone (10 digit numeric values only) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: email |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() |
Path | Conformance | ValueSet / Code | URI |
RelatedPerson.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype From the FHIR Standard | |
RelatedPerson.name.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Phone.system | required | Pattern Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Email.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
RelatedPerson | |||
![]() ![]() ![]() |
1..1 | Reference(UAPI Patient) | The patient this person is related to | |
![]() ![]() ![]() ![]() |
0..1 | string | Patient resource UUID | |
![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
![]() ![]() ![]() |
1..1 | CodeableConcept | The nature of the relationship | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
1..1 | HumanName | A name associated with the person | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | string | Up to 255 Characters | |
![]() ![]() ![]() ![]() |
1..1 | string | Up to 255 Characters | |
![]() ![]() ![]() |
1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The actual contact point details | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
![]() ![]() ![]() ![]() |
1..* | ContactPoint | A contact detail for the person | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Phone (10 digit numeric values only) | |
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Patient resource UUID | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 1..1 | HumanName | A name associated with the person | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Phone (10 digit numeric values only) | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: email | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() ![]() |
Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
![]() ![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
RelatedPerson.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype From the FHIR Standard | ||||
RelatedPerson.name.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Phone.system | required | Pattern Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Email.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.3.0 From the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | RelatedPerson.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
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() |
This structure is derived from RelatedPerson
Summary
Mandatory: 11 elements(2 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() ![]() |
Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Patient resource UUID |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
Σ | 1..1 | HumanName | A name associated with the person |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Phone (10 digit numeric values only) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: email |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() |
Path | Conformance | ValueSet / Code | URI |
RelatedPerson.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype From the FHIR Standard | |
RelatedPerson.name.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Phone.system | required | Pattern Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Email.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | |
RelatedPerson.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
RelatedPerson | |||
![]() ![]() ![]() |
1..1 | Reference(UAPI Patient) | The patient this person is related to | |
![]() ![]() ![]() ![]() |
0..1 | string | Patient resource UUID | |
![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
![]() ![]() ![]() |
1..1 | CodeableConcept | The nature of the relationship | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
1..1 | HumanName | A name associated with the person | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | string | Up to 255 Characters | |
![]() ![]() ![]() ![]() |
1..1 | string | Up to 255 Characters | |
![]() ![]() ![]() |
1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The actual contact point details | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
![]() ![]() ![]() ![]() |
1..* | ContactPoint | A contact detail for the person | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Phone (10 digit numeric values only) | |
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(UAPI Patient) | The patient this person is related to | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Patient resource UUID | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 1..1 | HumanName | A name associated with the person | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person Slice: Unordered, Closed by value:system | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: phone | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Phone (10 digit numeric values only) | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Required Pattern: email | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() ![]() |
Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
![]() ![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
RelatedPerson.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype From the FHIR Standard | ||||
RelatedPerson.name.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Phone.system | required | Pattern Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Email.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard | ||||
RelatedPerson.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.3.0 From the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | RelatedPerson.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
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() |
This structure is derived from RelatedPerson
Summary
Mandatory: 11 elements(2 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron