De-Identification, Anonymization, Redaction Toolkit Services
0.1.0 - STU1 Release 1 - Standard for Trial-Use United States of America flag

De-Identification, Anonymization, Redaction Toolkit Services, published by HL7 International / Cross Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-darts/ and changes regularly. See the Directory of published versions

Resource Profile: De-Identified UDS Plus RelatedPerson

Official URL: http://hl7.org/fhir/us/uds-plus/StructureDefinition/de-identified-uds-plus-relatedperson Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: DeIdentifiedUDSPlusRelatedPerson

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

All canonical (Official) URLs will be changed in the future and are not available currently on the web.

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Cannot include any text in the resource as part of the de-identified data.
... contained 0..0 Cannot include any contained resources in the resource as part of the de-identified data.
... patient S 1..1 Reference(De-Identified UDS Plus Patient) The patient this person is related to
.... display 0..0 Text alternative for the resource
... relationship S 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting.
.... text 0..0 Plain text representation of the concept
... name 0..0 Cannot include any name in the resource as part of the de-identified data.
... telecom 0..0 Cannot include any telecom information in the resource as part of the de-identified data.
... gender 0..0 Cannot include any gender information in the resource as part of the de-identified data.
... birthDate 0..0 Cannot include any date of birth information in the resource as part of the de-identified data.
... address 0..0 Cannot include any address information in the resource as part of the de-identified data.
... photo 0..0 Cannot include any photo information in the resource as part of the de-identified data.
... communication 0..0 Cannot include any communication information in the resource as part of the de-identified data.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
... period 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from RelatedPerson

Summary

Must-Support: 3 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Cannot include any text in the resource as part of the de-identified data.
... contained 0..0 Cannot include any contained resources in the resource as part of the de-identified data.
... patient S 1..1 Reference(De-Identified UDS Plus Patient) The patient this person is related to
.... display 0..0 Text alternative for the resource
... relationship S 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (extensible): The set of codes to be used for UDS+ reporting.
.... text 0..0 Plain text representation of the concept
... name 0..0 Cannot include any name in the resource as part of the de-identified data.
... telecom 0..0 Cannot include any telecom information in the resource as part of the de-identified data.
... gender 0..0 Cannot include any gender information in the resource as part of the de-identified data.
... birthDate 0..0 Cannot include any date of birth information in the resource as part of the de-identified data.
... address 0..0 Cannot include any address information in the resource as part of the de-identified data.
... photo 0..0 Cannot include any photo information in the resource as part of the de-identified data.
... communication 0..0 Cannot include any communication information in the resource as part of the de-identified data.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
... period 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from RelatedPerson

Summary

Must-Support: 3 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron