HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.0.2 - STU1 Release 1 - Standard for Trial-Use
HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG, published by HRSA BPHC. This guide is not an authorized publication; it is the continuous build for version 1.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/drajer-health/uds-plus/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-encounter | Version: 1.0.2 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: UDSPlusEncounter |
The UDS+ profile is based on the Encounter resource and establishes the core elements, extensions, vocabularies and value sets for representing encounters,visit information for UDS+ program.
This profile is used to represent de-identified Encounter 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, dates should not have a precision of more than the year. This means month and day cannot be included. This includes diagnosis dates, visit dates, onset dates etc.
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 Encounter resource text element may contain information such as the visit date. 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 using the visit date of the encounter to be included in the UDS+ report.
Capturing Location Information
The Encounter.location.location points to a Location Resource. The Location.type element can be used to indicate the type of location where the service was provided. The existing Location.type value set can be used to indicate that the service was provided in a SCHOOL based setting. This will be used to compute Table 4, LINE 24 of the UDS Report. For Table 4, Line 26 use the public-housing code defined in UDS+ value set that is referenced in the UDS+ Location profile.
Ids and References
The original Encounter resource id should not be included in the De-identified Encounter 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 Encounter. All resource references to the Encounter 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
Date Truncation
The Data Submitter has to truncate the following dates to only have a precision of year
The following is new content for 1.0.2.
Guidance on Encounter reason
The Encounter resource can represent a reason using either a code with Encounter.reasonCode, or a reference with Encounter.reasonReference to Condition or other resource.
Guidance on Encounter.serviceProvider
The Encounter.serviceProvider organization reference should point to the Organization resource that represents the FQHC which is responsible for rendering the services to the Patient.
Examples
Examples of identifiable data and its corresponding de-identifiable data is present in Reporting Guidance.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | De-Identified UDS Plus Encounter | |
![]() ![]() ![]() |
S | 0..1 | id | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Quantity | Age of the Patient computed using birthDate and the visit dates of the encounter URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): The set of codes indicating the type of encounter |
![]() ![]() ![]() |
S | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient or group present at the encounter |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() ![]() |
SC | 0..1 | Period | Period of time during the encounter that the participant participated uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient |
![]() ![]() ![]() |
SC | 0..1 | Period | The start and end time of the encounter uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Coded reason the encounter takes place |
![]() ![]() ![]() |
S | 0..* | Reference(De-Identified UDS Plus Diagnosis) | Reason the encounter takes place (reference) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(De-Identified UDS Plus Diagnosis) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): The set of codes indicating the discharge disposition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(UDS Plus Location) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | |
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition |
Id | Grade | Path(s) | Details | Requirements |
uds-plus-enc-1 | error | Encounter.participant.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-2 | error | Encounter.participant.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 | |
uds-plus-enc-3 | error | Encounter.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-4 | error | Encounter.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | De-Identified UDS Plus Encounter | |
![]() ![]() ![]() |
SΣ | 0..1 | id | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | Quantity | Age of the Patient computed using birthDate and the visit dates of the encounter URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): The set of codes indicating the type of encounter |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient or group present at the encounter |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
SC | 0..1 | Period | Period of time during the encounter that the participant participated uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient |
![]() ![]() ![]() |
SC | 0..1 | Period | The start and end time of the encounter uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() |
SΣ | 0..* | Reference(De-Identified UDS Plus Diagnosis) | Reason the encounter takes place (reference) |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Diagnosis) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): The set of codes indicating the discharge disposition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(UDS Plus Location) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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 | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | 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-enc-1 | error | Encounter.participant.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-2 | error | Encounter.participant.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 | |
uds-plus-enc-3 | error | Encounter.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-4 | error | Encounter.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Encounter | De-Identified UDS Plus Encounter | |||||
![]() ![]() ![]() |
SΣ | 0..1 | id | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | Quantity | Age of the Patient computed using birthDate and the visit dates of the encounter URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): The set of codes indicating the type of encounter | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient or group present at the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
SC | 0..1 | Period | Period of time during the encounter that the participant participated uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
SC | 0..1 | Period | The start and end time of the encounter uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. | ||||
![]() ![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(De-Identified UDS Plus Diagnosis) | Reason the encounter takes place (reference) | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Diagnosis) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): The set of codes indicating the discharge disposition | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(UDS Plus Location) | Location the encounter takes place | ||||
![]() ![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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 | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | 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-enc-1 | error | Encounter.participant.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-2 | error | Encounter.participant.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 | |
uds-plus-enc-3 | error | Encounter.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-4 | error | Encounter.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 |
This structure is derived from Encounter
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 22 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | De-Identified UDS Plus Encounter | |
![]() ![]() ![]() |
S | 0..1 | id | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Quantity | Age of the Patient computed using birthDate and the visit dates of the encounter URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): The set of codes indicating the type of encounter |
![]() ![]() ![]() |
S | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient or group present at the encounter |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() ![]() |
SC | 0..1 | Period | Period of time during the encounter that the participant participated uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient |
![]() ![]() ![]() |
SC | 0..1 | Period | The start and end time of the encounter uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Coded reason the encounter takes place |
![]() ![]() ![]() |
S | 0..* | Reference(De-Identified UDS Plus Diagnosis) | Reason the encounter takes place (reference) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(De-Identified UDS Plus Diagnosis) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): The set of codes indicating the discharge disposition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(UDS Plus Location) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | |
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition |
Id | Grade | Path(s) | Details | Requirements |
uds-plus-enc-1 | error | Encounter.participant.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-2 | error | Encounter.participant.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 | |
uds-plus-enc-3 | error | Encounter.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-4 | error | Encounter.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | De-Identified UDS Plus Encounter | |
![]() ![]() ![]() |
SΣ | 0..1 | id | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | Quantity | Age of the Patient computed using birthDate and the visit dates of the encounter URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): The set of codes indicating the type of encounter |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient or group present at the encounter |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
SC | 0..1 | Period | Period of time during the encounter that the participant participated uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient |
![]() ![]() ![]() |
SC | 0..1 | Period | The start and end time of the encounter uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() |
SΣ | 0..* | Reference(De-Identified UDS Plus Diagnosis) | Reason the encounter takes place (reference) |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Diagnosis) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): The set of codes indicating the discharge disposition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(UDS Plus Location) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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 | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | 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-enc-1 | error | Encounter.participant.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-2 | error | Encounter.participant.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 | |
uds-plus-enc-3 | error | Encounter.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-4 | error | Encounter.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Encounter | De-Identified UDS Plus Encounter | |||||
![]() ![]() ![]() |
SΣ | 0..1 | id | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | Quantity | Age of the Patient computed using birthDate and the visit dates of the encounter URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-age-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): The set of codes indicating the type of encounter | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Patient) | The patient or group present at the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
SC | 0..1 | Period | Period of time during the encounter that the participant participated uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
SC | 0..1 | Period | The start and end time of the encounter uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. | ||||
![]() ![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(De-Identified UDS Plus Diagnosis) | Reason the encounter takes place (reference) | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(De-Identified UDS Plus Diagnosis) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): The set of codes indicating the discharge disposition | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(UDS Plus Location) | Location the encounter takes place | ||||
![]() ![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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 | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | 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-enc-1 | error | Encounter.participant.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-2 | error | Encounter.participant.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 | |
uds-plus-enc-3 | error | Encounter.period | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.start.exists() implies $this.start.toString().length() = 4 | |
uds-plus-enc-4 | error | Encounter.period | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and $this.end.exists() implies $this.end.toString().length() = 4 |
This structure is derived from Encounter
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 22 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron