HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.0.1 - STU1 Release 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.0.1: 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 Patient

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-patient Version: 1.0.1
Standards status: Trial-use Maturity Level: 2 Computable Name: DeIdentifiedUDSPlusPatient

This Patient profile represents a Patient availing HRSA services.

Introduction

This profile is used to represent de-identified patient 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.

According to the HHS guidance the following data elements have to be removed or de-identified

  • Patient Name

  • Address that is more specific than a state

    • First 3 digits of Zipcodes can be included if the population of all zipcodes starting with the same 3 digits are > 20000 people and the last 2 digits should be masked with “00”, in all other cases, the zipcodes have to be masked to 00000.
  • All dates should not have a precision of more than the year. This means month and day cannot be included.
  • Demographics including birthdate, deceased indicator
  • Patient contact details such as telephone numbers, fax, email, URLs,
  • Patient personal identifiers such as SSN, Drivers License,
  • Business identifiers such as MRNs, certificate numbers, Account numbers
  • Biometrics such as fingerprints, photos

In FHIR Resources, text 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 Patient resource text element may contain information such as the full name, Gender and Date of Birth. 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.

Age Computation

The Data Submitter has to compute the age based as of December 31st of the previous year for inclusion in the UDS+ report.

Id Generation

The original patient resource id should not be included in the De-identified patient 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 patient. All resource references to the Patient submitted as part of the UDS+ report should refer to newly generated de-identified id.

Usage of Data Absent Reason Extension

For the UDS+ reporting, the patient data is de-identified and in the process zip codes may be masked to a value of “00000”. In these cases the dataAbsentReason extension must be added to identify that the data is “masked”. If the zip code is not known, a value of “00000” must be sent with a dataAbsentReason of “unknown”. If the zip code is outside the country, a value of “00000” must be sent with a dataAbsentReason of “unsupported”.

Birth Sex Additional Constraints

NullFlavors are not allowed for BirthSex reporting for UDS+ even though they are allowed in US Core.

Race and Ethnicity Additional Constraints

US Core allows Race and Ethnicity to be described as only text or rolled up to the OMB categories, however for UDS+ reporting detailed race and ethnicity have to be captured and reported as part of the profile. If the reported race and ethncity values are not null flavors then detailed values are mandatory.

Sexual Orientation Additional Constraints

Health Centers which have not implemented the methods to capture Sexual Orientation, should use the null flavor coded value of “NASK” specifically.

Gender Identity Additional Constraints

Health Centers which have not implemented the methods to capture Gender Identity, should use the null flavor coded value of “NASK” specifically.

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 Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientDe-Identified UDS Plus Patient
... id S0..1idThe de-identified patient identifier created by the health center to send data to HRSA.
... text 0..0
... contained 0..0
... uds-plus-ethnicty S1..1(Complex)Indicates the ethnicity of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-ethnicity-extension
... uds-plus-birthsex S1..1codeIndicates the birth sex of the Patient.
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-birthsex-extension
Binding: Uds Plus Birth Sex Codes (required): The set of codes to be used for UDS+ reporting.

... uds-plus-age-extension S1..1QuantityAge of the Patient computed using birthDate and the reporting period reference
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension
... uds-plus-gender-identity-extension S0..1CodeableConceptGender Identity of the pateient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-gender-identity-extension
Binding: Uds Plus Gender Identity Codes (extensible): The set of codes to be used for UDS+ reporting.

... uds-plus-agriculture-worker-status S0..1codeAgriculture Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/udsplus-agriculture-worker-status
Binding: Uds Plus Agriculture Worker Status Codes (extensible)
... uds-plus-housing-status S0..1codeHousing Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension
Binding: Uds Plus Housing Status Codes (extensible)
... uds-plus-veteran-status S0..1booleanVeteran Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-veteran-status-extension
... identifier 0..0
... name 0..0
... telecom 0..0
... birthDate 0..0
... deceasedBoolean S0..1booleanCan only have deceased boolean.
... address S1..1AddressIncluded only to support zip code
.... text 0..0
.... line 0..0
.... postalCode S1..1stringZipCode must be included in the profile
..... dataAbsentReason S0..1codeReason why the data is not present
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

...... value[x] S1..1codeValue of extension
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication
.... language S1..1CodeableConceptLanguage must be included in the profile
Binding: Language codes with language and optionally a region modifier (extensible): The set of languages that the patient uses

... generalPractitioner 0..0
... managingOrganization 0..0
... link 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientDe-Identified UDS Plus Patient
... id SΣ0..1idThe de-identified patient identifier created by the health center to send data to HRSA.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 4..*ExtensionExtension
Slice: Unordered, Open by value:url
... uds-plus-ethnicty S1..1(Complex)Indicates the ethnicity of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-ethnicity-extension
... uds-plus-birthsex S1..1codeIndicates the birth sex of the Patient.
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-birthsex-extension
Binding: Uds Plus Birth Sex Codes (required): The set of codes to be used for UDS+ reporting.


... uds-plus-age-extension S1..1QuantityAge of the Patient computed using birthDate and the reporting period reference
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension
... uds-plus-gender-identity-extension S0..1CodeableConceptGender Identity of the pateient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-gender-identity-extension
Binding: Uds Plus Gender Identity Codes (extensible): The set of codes to be used for UDS+ reporting.


... uds-plus-agriculture-worker-status S0..1codeAgriculture Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/udsplus-agriculture-worker-status
Binding: Uds Plus Agriculture Worker Status Codes (extensible)
... uds-plus-housing-status S0..1codeHousing Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension
Binding: Uds Plus Housing Status Codes (extensible)
... uds-plus-veteran-status S0..1booleanVeteran Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-veteran-status-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for deceased[x] ?!Σ0..1booleanIndicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean ?!SΣ0..1booleanCan only have deceased boolean.
... address SΣ1..1AddressIncluded only to support zip code
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... postalCode SΣ1..1stringZipCode must be included in the profile
Example General: 9132
..... dataAbsentReason S0..1codeReason why the data is not present
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptLanguage must be included in the profile
Binding: Language codes with language and optionally a region modifier (extensible): The set of languages that the patient uses


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.address.userequiredAddressUse
Patient.address.postalCode.extension:dataAbsentReason.value[x]requiredDataAbsentReason
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientDe-Identified UDS Plus Patient
... id SΣ0..1idThe de-identified patient identifier created by the health center to send data to HRSA.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 4..*ExtensionExtension
Slice: Unordered, Open by value:url
... uds-plus-race S1..1(Complex)Indicates the race of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-race-extension
... uds-plus-ethnicty S1..1(Complex)Indicates the ethnicity of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-ethnicity-extension
... uds-plus-birthsex S1..1codeIndicates the birth sex of the Patient.
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-birthsex-extension
Binding: Uds Plus Birth Sex Codes (required): The set of codes to be used for UDS+ reporting.


... uds-plus-age-extension S1..1QuantityAge of the Patient computed using birthDate and the reporting period reference
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension
... uds-plus-gender-identity-extension S0..1CodeableConceptGender Identity of the pateient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-gender-identity-extension
Binding: Uds Plus Gender Identity Codes (extensible): The set of codes to be used for UDS+ reporting.


... uds-plus-agriculture-worker-status S0..1codeAgriculture Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/udsplus-agriculture-worker-status
Binding: Uds Plus Agriculture Worker Status Codes (extensible)
... uds-plus-housing-status S0..1codeHousing Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension
Binding: Uds Plus Housing Status Codes (extensible)
... uds-plus-veteran-status S0..1booleanVeteran Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-veteran-status-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this patient's record is in active use
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... Slices for deceased[x] ?!Σ0..1booleanIndicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean ?!SΣ0..1booleanCan only have deceased boolean.
... address SΣ1..1AddressIncluded only to support zip code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ1..1stringZipCode must be included in the profile
Example General: 9132
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeReason why the data is not present
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptLanguage must be included in the profile
Binding: Language codes with language and optionally a region modifier (extensible): The set of languages that the patient uses

.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.postalCode.extension:dataAbsentReason.value[x]requiredDataAbsentReason
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientDe-Identified UDS Plus Patient
... id S0..1idThe de-identified patient identifier created by the health center to send data to HRSA.
... text 0..0
... contained 0..0
... uds-plus-ethnicty S1..1(Complex)Indicates the ethnicity of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-ethnicity-extension
... uds-plus-birthsex S1..1codeIndicates the birth sex of the Patient.
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-birthsex-extension
Binding: Uds Plus Birth Sex Codes (required): The set of codes to be used for UDS+ reporting.

... uds-plus-age-extension S1..1QuantityAge of the Patient computed using birthDate and the reporting period reference
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension
... uds-plus-gender-identity-extension S0..1CodeableConceptGender Identity of the pateient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-gender-identity-extension
Binding: Uds Plus Gender Identity Codes (extensible): The set of codes to be used for UDS+ reporting.

... uds-plus-agriculture-worker-status S0..1codeAgriculture Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/udsplus-agriculture-worker-status
Binding: Uds Plus Agriculture Worker Status Codes (extensible)
... uds-plus-housing-status S0..1codeHousing Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension
Binding: Uds Plus Housing Status Codes (extensible)
... uds-plus-veteran-status S0..1booleanVeteran Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-veteran-status-extension
... identifier 0..0
... name 0..0
... telecom 0..0
... birthDate 0..0
... deceasedBoolean S0..1booleanCan only have deceased boolean.
... address S1..1AddressIncluded only to support zip code
.... text 0..0
.... line 0..0
.... postalCode S1..1stringZipCode must be included in the profile
..... dataAbsentReason S0..1codeReason why the data is not present
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

...... value[x] S1..1codeValue of extension
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication
.... language S1..1CodeableConceptLanguage must be included in the profile
Binding: Language codes with language and optionally a region modifier (extensible): The set of languages that the patient uses

... generalPractitioner 0..0
... managingOrganization 0..0
... link 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientDe-Identified UDS Plus Patient
... id SΣ0..1idThe de-identified patient identifier created by the health center to send data to HRSA.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 4..*ExtensionExtension
Slice: Unordered, Open by value:url
... uds-plus-ethnicty S1..1(Complex)Indicates the ethnicity of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-ethnicity-extension
... uds-plus-birthsex S1..1codeIndicates the birth sex of the Patient.
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-birthsex-extension
Binding: Uds Plus Birth Sex Codes (required): The set of codes to be used for UDS+ reporting.


... uds-plus-age-extension S1..1QuantityAge of the Patient computed using birthDate and the reporting period reference
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension
... uds-plus-gender-identity-extension S0..1CodeableConceptGender Identity of the pateient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-gender-identity-extension
Binding: Uds Plus Gender Identity Codes (extensible): The set of codes to be used for UDS+ reporting.


... uds-plus-agriculture-worker-status S0..1codeAgriculture Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/udsplus-agriculture-worker-status
Binding: Uds Plus Agriculture Worker Status Codes (extensible)
... uds-plus-housing-status S0..1codeHousing Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension
Binding: Uds Plus Housing Status Codes (extensible)
... uds-plus-veteran-status S0..1booleanVeteran Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-veteran-status-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for deceased[x] ?!Σ0..1booleanIndicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean ?!SΣ0..1booleanCan only have deceased boolean.
... address SΣ1..1AddressIncluded only to support zip code
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... postalCode SΣ1..1stringZipCode must be included in the profile
Example General: 9132
..... dataAbsentReason S0..1codeReason why the data is not present
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptLanguage must be included in the profile
Binding: Language codes with language and optionally a region modifier (extensible): The set of languages that the patient uses


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.address.userequiredAddressUse
Patient.address.postalCode.extension:dataAbsentReason.value[x]requiredDataAbsentReason
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientDe-Identified UDS Plus Patient
... id SΣ0..1idThe de-identified patient identifier created by the health center to send data to HRSA.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 4..*ExtensionExtension
Slice: Unordered, Open by value:url
... uds-plus-race S1..1(Complex)Indicates the race of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-race-extension
... uds-plus-ethnicty S1..1(Complex)Indicates the ethnicity of the Patient.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-ethnicity-extension
... uds-plus-birthsex S1..1codeIndicates the birth sex of the Patient.
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-birthsex-extension
Binding: Uds Plus Birth Sex Codes (required): The set of codes to be used for UDS+ reporting.


... uds-plus-age-extension S1..1QuantityAge of the Patient computed using birthDate and the reporting period reference
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension
... uds-plus-gender-identity-extension S0..1CodeableConceptGender Identity of the pateient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-gender-identity-extension
Binding: Uds Plus Gender Identity Codes (extensible): The set of codes to be used for UDS+ reporting.


... uds-plus-agriculture-worker-status S0..1codeAgriculture Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/udsplus-agriculture-worker-status
Binding: Uds Plus Agriculture Worker Status Codes (extensible)
... uds-plus-housing-status S0..1codeHousing Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension
Binding: Uds Plus Housing Status Codes (extensible)
... uds-plus-veteran-status S0..1booleanVeteran Status of the patient
URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-veteran-status-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this patient's record is in active use
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... Slices for deceased[x] ?!Σ0..1booleanIndicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean ?!SΣ0..1booleanCan only have deceased boolean.
... address SΣ1..1AddressIncluded only to support zip code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ1..1stringZipCode must be included in the profile
Example General: 9132
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeReason why the data is not present
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptLanguage must be included in the profile
Binding: Language codes with language and optionally a region modifier (extensible): The set of languages that the patient uses

.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.postalCode.extension:dataAbsentReason.value[x]requiredDataAbsentReason
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()

 

Other representations of profile: CSV, Excel, Schematron