HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.1.0 - STU1 Release 1.1 - Standard for Trial-Use International flag

This page is part of the HRSA Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+ or uds-plus) FHIR IG (v1.1.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: De-Identified UDS Plus RelatedPerson

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-relatedperson Version: 1.1.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:

Formal Views of Profile Content

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

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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-res-10: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-res-11: All Period.end data elements should be truncated to a year only for de-identified resources.
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
uds-plus-res-10errorRelatedPerson.periodAll 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-res-11errorRelatedPerson.periodAll 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(De-Identified UDS Plus Patient) The patient this person is related to
... 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-res-10: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-res-11: All Period.end data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-res-10errorRelatedPerson.periodAll 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-res-11errorRelatedPerson.periodAll 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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-res-10: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-res-11: All Period.end data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
RelatedPerson.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-res-10errorRelatedPerson.periodAll 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-res-11errorRelatedPerson.periodAll 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

This structure is derived from RelatedPerson

Summary

Must-Support: 3 elements
Prohibited: 11 elements

Structures

This structure refers to these other structures:

Maturity: 2

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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-res-10: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-res-11: All Period.end data elements should be truncated to a year only for de-identified resources.
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
uds-plus-res-10errorRelatedPerson.periodAll 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-res-11errorRelatedPerson.periodAll 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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(De-Identified UDS Plus Patient) The patient this person is related to
... 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-res-10: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-res-11: All Period.end data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-res-10errorRelatedPerson.periodAll 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-res-11errorRelatedPerson.periodAll 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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-res-10: All Period.start data elements should be truncated to a year only for de-identified resources.
uds-plus-res-11: All Period.end data elements should be truncated to a year only for de-identified resources.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
RelatedPerson.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
uds-plus-res-10errorRelatedPerson.periodAll 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-res-11errorRelatedPerson.periodAll 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

This structure is derived from RelatedPerson

Summary

Must-Support: 3 elements
Prohibited: 11 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron