HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
2.0.0 - STU2 Release 1 - Standard for Trial-Use

Publication Build: This will be filled in by the publication tooling

## Resource Profile: De-Identified UDS Plus RelatedPerson

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-relatedperson | Version: 2.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: DeIdentifiedUDSPlusRelatedPerson

This Patient profile represents a RelatedPerson of a Patient availing HRSA services.

### Introduction

This profile is used to represent de-identified RelatdPerson information. The de-identification process has to remove all data elements not explicitly identified as "SUPPORTED" in the profile.

The HHS De-identification Guidance is to be followed to ensure appropriate level of de-identification is performed.

In FHIR Resources, text elements and reference.display elements which provide human readable information to the providers may be generated using programs and tools from the data present within the resource. For e.g a RelatedPerson resource text element may contain information such as the RelatedPerson name. This type of information will enable identification of the individuals. In order to avoid inadvertent revealing of PII/PHI, text elements cannot be included in the De-identified FHIR resource and the submission will be rejected when text elements are present by the validation process.

Ids and References

The original RelatedPerson resource id should not be included in the De-identified RelatedPerson instance. Instead a new id should be created and provided as part of the FHIR resource. This Data Submitter should be capable of using the generated id to relink the data to the original RelatedPerson. All resource references to the RelatedPerson submitted as part of the UDS+ report should refer to newly generated id.

Resource references cannot contain text element as it may contain PHI/PII. The text element for following references are not allowed

- patient

Examples

Examples of identifiable data and its corresponding de-identifiable data is present in Reporting Guidance.

Usage:

- Refer to this Resource Profile: De-Identified UDS Plus Coverage
- Examples for this Resource Profile: RelatedPerson/de-identified-example

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | De-Identified UDS Plus RelatedPerson dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id | S Σ | 0..1 | id | The de-identified RelatedPerson identifier created by the health center to send data to HRSA.
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children
relationship | S Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting. ele-1: All FHIR elements must have a @value or children
period | C | 0..1 | Period | Period of time that this relationship is considered valid ele-1: All FHIR elements must have a @value or children uds-plus-rel-10: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-rel-10a: All Period.start data elements should have valid year > 1900 uds-plus-rel-10b: All Period.start data elements should have valid year < 2030 uds-plus-rel-11: All Period.end data elements should be truncated to a year only for de-identified resources. uds-plus-rel-11a: All Period.end data elements should have valid year > 1900 uds-plus-rel-11b: All Period.end data elements should have valid year < 2030
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
RelatedPerson.relationship | extensible | PatientRelationshipType `http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype` from the FHIR Standard
RelatedPerson.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

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 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(canonical) = '#').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() |
uds-plus-rel-10 | error | RelatedPerson.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-rel-10a | error | RelatedPerson.period | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-rel-10b | error | RelatedPerson.period | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-rel-11 | error | RelatedPerson.period | All Period.end data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-rel-11a | error | RelatedPerson.period | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-rel-11b | error | RelatedPerson.period | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |

This structure is derived from RelatedPerson

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | De-Identified UDS Plus RelatedPerson
id | S | 0..1 | id | The de-identified RelatedPerson identifier created by the health center to send data to HRSA.
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
patient | S | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient this person is related to
display |  | 0..0 |  |
relationship | S | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting.
name |  | 0..0 |  |
telecom |  | 0..0 |  |
gender |  | 0..0 |  |
birthDate |  | 0..0 |  |
address |  | 0..0 |  |
photo |  | 0..0 |  |
period | C | 0..1 | Period | Period of time that this relationship is considered valid uds-plus-rel-10: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-rel-10a: All Period.start data elements should have valid year > 1900 uds-plus-rel-10b: All Period.start data elements should have valid year < 2030 uds-plus-rel-11: All Period.end data elements should be truncated to a year only for de-identified resources. uds-plus-rel-11a: All Period.end data elements should have valid year > 1900 uds-plus-rel-11b: All Period.end data elements should have valid year < 2030
communication |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
RelatedPerson.relationship | extensible | PatientRelationshipType `http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
uds-plus-rel-10 | error | RelatedPerson.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-rel-10a | error | RelatedPerson.period | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-rel-10b | error | RelatedPerson.period | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-rel-11 | error | RelatedPerson.period | All Period.end data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-rel-11a | error | RelatedPerson.period | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-rel-11b | error | RelatedPerson.period | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | De-Identified UDS Plus RelatedPerson
id | S Σ | 0..1 | id | The de-identified RelatedPerson identifier created by the health center to send data to HRSA.
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient this person is related to
id |  | 0..1 | string | 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 | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
relationship | S Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting.
period | C | 0..1 | Period | Period of time that this relationship is considered valid uds-plus-rel-10: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-rel-10a: All Period.start data elements should have valid year > 1900 uds-plus-rel-10b: All Period.start data elements should have valid year < 2030 uds-plus-rel-11: All Period.end data elements should be truncated to a year only for de-identified resources. uds-plus-rel-11a: All Period.end data elements should have valid year > 1900 uds-plus-rel-11b: All Period.end data elements should have valid year < 2030
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
RelatedPerson.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
RelatedPerson.patient.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
RelatedPerson.relationship | extensible | PatientRelationshipType `http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype` from the FHIR Standard
RelatedPerson.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

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 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(canonical) = '#').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() |
uds-plus-rel-10 | error | RelatedPerson.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-rel-10a | error | RelatedPerson.period | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-rel-10b | error | RelatedPerson.period | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-rel-11 | error | RelatedPerson.period | All Period.end data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-rel-11a | error | RelatedPerson.period | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-rel-11b | error | RelatedPerson.period | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |

This structure is derived from RelatedPerson

Summary

Must-Support: 3 elements
Prohibited: 11 elements

Structures

This structure refers to these other structures:

- De-Identified UDS Plus Patient (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-patient)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | De-Identified UDS Plus RelatedPerson dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id | S Σ | 0..1 | id | The de-identified RelatedPerson identifier created by the health center to send data to HRSA.
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children
relationship | S Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting. ele-1: All FHIR elements must have a @value or children
period | C | 0..1 | Period | Period of time that this relationship is considered valid ele-1: All FHIR elements must have a @value or children uds-plus-rel-10: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-rel-10a: All Period.start data elements should have valid year > 1900 uds-plus-rel-10b: All Period.start data elements should have valid year < 2030 uds-plus-rel-11: All Period.end data elements should be truncated to a year only for de-identified resources. uds-plus-rel-11a: All Period.end data elements should have valid year > 1900 uds-plus-rel-11b: All Period.end data elements should have valid year < 2030
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
RelatedPerson.relationship | extensible | PatientRelationshipType `http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype` from the FHIR Standard
RelatedPerson.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

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 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(canonical) = '#').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() |
uds-plus-rel-10 | error | RelatedPerson.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-rel-10a | error | RelatedPerson.period | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-rel-10b | error | RelatedPerson.period | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-rel-11 | error | RelatedPerson.period | All Period.end data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-rel-11a | error | RelatedPerson.period | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-rel-11b | error | RelatedPerson.period | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |

Differential View

This structure is derived from RelatedPerson

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | De-Identified UDS Plus RelatedPerson
id | S | 0..1 | id | The de-identified RelatedPerson identifier created by the health center to send data to HRSA.
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
patient | S | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient this person is related to
display |  | 0..0 |  |
relationship | S | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting.
name |  | 0..0 |  |
telecom |  | 0..0 |  |
gender |  | 0..0 |  |
birthDate |  | 0..0 |  |
address |  | 0..0 |  |
photo |  | 0..0 |  |
period | C | 0..1 | Period | Period of time that this relationship is considered valid uds-plus-rel-10: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-rel-10a: All Period.start data elements should have valid year > 1900 uds-plus-rel-10b: All Period.start data elements should have valid year < 2030 uds-plus-rel-11: All Period.end data elements should be truncated to a year only for de-identified resources. uds-plus-rel-11a: All Period.end data elements should have valid year > 1900 uds-plus-rel-11b: All Period.end data elements should have valid year < 2030
communication |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
RelatedPerson.relationship | extensible | PatientRelationshipType `http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
uds-plus-rel-10 | error | RelatedPerson.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-rel-10a | error | RelatedPerson.period | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-rel-10b | error | RelatedPerson.period | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-rel-11 | error | RelatedPerson.period | All Period.end data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-rel-11a | error | RelatedPerson.period | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-rel-11b | error | RelatedPerson.period | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | De-Identified UDS Plus RelatedPerson
id | S Σ | 0..1 | id | The de-identified RelatedPerson identifier created by the health center to send data to HRSA.
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient this person is related to
id |  | 0..1 | string | 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 | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
relationship | S Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting.
period | C | 0..1 | Period | Period of time that this relationship is considered valid uds-plus-rel-10: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-rel-10a: All Period.start data elements should have valid year > 1900 uds-plus-rel-10b: All Period.start data elements should have valid year < 2030 uds-plus-rel-11: All Period.end data elements should be truncated to a year only for de-identified resources. uds-plus-rel-11a: All Period.end data elements should have valid year > 1900 uds-plus-rel-11b: All Period.end data elements should have valid year < 2030
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
RelatedPerson.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
RelatedPerson.patient.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
RelatedPerson.relationship | extensible | PatientRelationshipType `http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype` from the FHIR Standard
RelatedPerson.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

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 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(canonical) = '#').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() |
uds-plus-rel-10 | error | RelatedPerson.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-rel-10a | error | RelatedPerson.period | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-rel-10b | error | RelatedPerson.period | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-rel-11 | error | RelatedPerson.period | All Period.end data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-rel-11a | error | RelatedPerson.period | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-rel-11b | error | RelatedPerson.period | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |

This structure is derived from RelatedPerson

Summary

Must-Support: 3 elements
Prohibited: 11 elements

Structures

This structure refers to these other structures:

- De-Identified UDS Plus Patient (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-patient)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron