UDS Plus Housing Status Extension - Definitions - HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG v2.0.0

HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
2.0.0 - STU2 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 (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: UDSPlusHousingStatusExtension - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 2

Definitions for the uds-plus-housing-status-extension extension.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	Indicates the housing status of the Patient at a specific time Optional Extension Element - found in all resources.
Short	Indicates the housing status of the Patient.Optional Extensions Element
Control	10..1* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension`
4. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	10..1
Binding	Unless not suitable, these codes SHALL be taken from For codes, see Uds Plus Housing Status Codes (extensible to `http://fhir.org/guides/hrsa/uds-plus/ValueSet/udsplus-housing-status`)
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	Indicates the housing status of the Patient at a specific time
Short	Indicates the housing status of the Patient.
Control	1..1
2. Extension.url
Type	uri
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Fixed Value	`http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension`
4. Extension.value[x]
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from Uds Plus Housing Status Codes (extensible to `http://fhir.org/guides/hrsa/uds-plus/ValueSet/udsplus-housing-status`)
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	Indicates the housing status of the Patient at a specific time
Short	Indicates the housing status of the Patient.
Control	1..1 This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-housing-status-extension`
8. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from Uds Plus Housing Status Codes (extensible to `http://fhir.org/guides/hrsa/uds-plus/ValueSet/udsplus-housing-status`)
Type	code
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)