abstractbaseDefinitioncopyrightdate- Values Differ
description- Values Differ
experimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisher- Values Differ
purposestatustitletypeurlversion- Values Differ
| Left: | US Core Encounter Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter) |
| Right: | US Core Encounter Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter) |
| Error | StructureDefinition.version | Values for version differ: '3.1.1' vs '10.0.0-ballot' |
| Information | StructureDefinition.date | Values for date differ: '2019-05-21' vs '2023-10-17' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 US Realm Steering Committee' vs 'HL7 International / Cross-Group Projects' |
| Information | StructureDefinition.definition | Values for definition differ: 'This is basic constraint on Encounter for use in US Core resources.' vs 'An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.' |
| Warning | Encounter.meta | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Information | Encounter.language | Example/preferred bindings differ at Encounter.language using binding from USCoreEncounterProfile |
| Information | StructureDefinition.short | Values for short differ: 'Additional content defined by implementations' vs 'Extension' |
| Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the resource. 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.' vs 'An Extension' |
| Information | StructureDefinition.short | Values for short differ: 'The appointment that scheduled this encounter' vs '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter' |
| Information | Encounter.reasonCode | Example/preferred bindings differ at Encounter.reasonCode using binding from USCoreEncounterProfile |
| Warning | Encounter.reasonReference | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Information | Encounter.diagnosis.use | Example/preferred bindings differ at Encounter.diagnosis.use using binding from USCoreEncounterProfile |
| Information | Encounter.hospitalization.admitSource | Example/preferred bindings differ at Encounter.hospitalization.admitSource using binding from USCoreEncounterProfile |
| Information | Encounter.hospitalization.specialCourtesy | Example/preferred bindings differ at Encounter.hospitalization.specialCourtesy using binding from USCoreEncounterProfile |
| Information | Encounter.hospitalization.specialArrangement | Example/preferred bindings differ at Encounter.hospitalization.specialArrangement using binding from USCoreEncounterProfile |
| Information | Encounter.hospitalization.dischargeDisposition | Example/preferred bindings differ at Encounter.hospitalization.dischargeDisposition using binding from USCoreEncounterProfile |
| Warning | Encounter.serviceProvider | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/StructureDefinition/Encounter | ||
| copyright | |||
| date | 2019-05-21 | 2023-10-17 |
|
| description | The Encounter referenced in the US Core profiles. | The US Core Encounter Profile inherits from the FHIR [Encounter](https://hl7.org/fhir/R4/encounter.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. |
|
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCoreEncounterProfile | ||
| publisher | HL7 US Realm Steering Committee | HL7 International / Cross-Group Projects |
|
| purpose | |||
| status | active | ||
| title | US Core Encounter Profile | ||
| type | Encounter | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter | ||
| version | 3.1.1 | 10.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | 0..* | Encounter | An interaction during which services are provided to the patient | |||||||||||
 id | 0..1 | id | Logical id of this artifact | 0..1 | id | Logical id of this artifact | |||||||||||
| meta | 0..1 | Meta | Metadata about the resource | 0..1 | Meta | Metadata about the resource |
| ||||||||||
 id | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
 Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
| versionId | 0..1 | id | Version specific identifier |
| |||||||||||||
| lastUpdated | 0..1 | instant | When the resource last changed |
| |||||||||||||
| source | 0..1 | uri | Identifies where the resource comes from |
| |||||||||||||
| profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| |||||||||||||
| security | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| |||||||||||||
| tag | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| |||||||||||||
| implicitRules | 0..1 | uri | A set of rules under which this content was created | 0..1 | uri | A set of rules under which this content was created | |||||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
|
| ||||||||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
 modifierExtension | 0..* | Extension | Extensions that cannot be ignored | 0..* | Extension | Extensions that cannot be ignored | |||||||||||
| identifier | 0..* | Identifier | Identifier(s) by which this encounter is known | 0..* | Identifier | Identifier(s) by which this encounter is known | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||||
| type | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||||
| system | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||||||||
| value | 1..1 | string | The value that is unique Example General: 123456 | 1..1 | string | The value that is unique Example General: 123456 | |||||||||||
| period | 0..1 | Period | Time period when id is/was valid for use | 0..1 | Period | Time period when id is/was valid for use | |||||||||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: ?? (required): Current state of the encounter. | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: ?? (required): Current state of the encounter. | |||||||||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | 0..* | BackboneElement | List of past encounter statuses | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: ?? (required): Current state of the encounter. | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: ?? (required): Current state of the encounter. | |||||||||||
| period | 1..1 | Period | The time that the episode was in the specified status | 1..1 | Period | The time that the episode was in the specified status | |||||||||||
| class | 1..1 | Coding | Classification of patient encounter Binding: ?? (extensible): Classification of the encounter. | 1..1 | Coding | Classification of patient encounter Binding: ?? (extensible): Classification of the encounter. | |||||||||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | 0..* | BackboneElement | List of past encounter classes | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ?? (extensible): Classification of the encounter. | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ?? (extensible): Classification of the encounter. | |||||||||||
| period | 1..1 | Period | The time that the episode was in the specified class | 1..1 | Period | The time that the episode was in the specified class | |||||||||||
| type | 1..* | CodeableConcept | Specific type of encounter Binding: ?? (extensible): Valueset to describe the Encounter Type | 1..* | CodeableConcept | Specific type of encounter Binding: ?? (extensible): Valueset to describe the Encounter Type | |||||||||||
| serviceType | 0..1 | CodeableConcept | Specific type of service Binding: ?? (example): Broad categorization of the service that is to be provided. | 0..1 | CodeableConcept | Specific type of service Binding: ?? (example): Broad categorization of the service that is to be provided. | |||||||||||
| priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ?? (example): Indicates the urgency of the encounter. | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ?? (example): Indicates the urgency of the encounter. | |||||||||||
| subject | 1..1 | Reference(US Core Patient Profile) | The patient or group present at the encounter | 1..1 | Reference(US Core Patient Profile | Group) | The patient or group present at the encounter | |||||||||||
| episodeOfCare | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||||||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||||||||
| participant | 0..* | BackboneElement | List of participants involved in the encounter | 0..* | BackboneElement | List of participants involved in the encounter | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| type | 0..* | CodeableConcept | Role of participant in encounter Binding: ?? (extensible): Role of participant in encounter. | 0..* | CodeableConcept | Role of participant in encounter Binding: ?? (extensible): Role of participant in encounter. | |||||||||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | 0..1 | Period | Period of time during the encounter that the participant participated | |||||||||||
| individual | 0..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile) | Persons involved in the encounter other than the patient | |||||||||||
| appointment | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | 0..* | Reference(US Core Appointment Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter | |||||||||||
| period | 0..1 | Period | The start and end time of the encounter | 0..1 | Period | The start and end time of the encounter | |||||||||||
| length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||||||||
| reasonCode | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: ?? (preferred): Reason why the encounter takes place. | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: ?? (preferred): Reason why the encounter takes place. |
| ||||||||||
| reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | 0..* | Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile | US Core Procedure Profile | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
| ||||||||||
| diagnosis | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| condition | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |||||||||||
| use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ?? (preferred): The type of diagnosis this condition represents. | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ?? (preferred): The type of diagnosis this condition represents. |
| ||||||||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||||||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||||||||
| hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | 0..1 | Identifier | Pre-admission identifier | |||||||||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||||||||
| admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: ?? (preferred): From where the patient was admitted. | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: ?? (preferred): From where the patient was admitted. |
| ||||||||||
| reAdmission | 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: ?? (example): The reason for re-admission of this hospitalization encounter. | 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: ?? (example): The reason for re-admission of this hospitalization encounter. | |||||||||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: ?? (example): Medical, cultural or ethical food preferences to help with catering requirements. | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: ?? (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||||||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: ?? (preferred): Special courtesies. | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: ?? (preferred): Special courtesies. |
| ||||||||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: ?? (preferred): Special arrangements. | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: ?? (preferred): Special arrangements. |
| ||||||||||
| destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||||||||
| dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: ?? (example): Discharge Disposition. | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: ?? (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 |
| ||||||||||
| location | 0..* | BackboneElement | List of locations where the patient has been | 0..* | BackboneElement | List of locations where the patient has been | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| location | 1..1 | Reference(Location) | Location the encounter takes place | 1..1 | Reference(US Core Location Profile) | Location the encounter takes place | |||||||||||
| status | 0..1 | code | planned | active | reserved | completed Binding: ?? (required): The status of the location. | 0..1 | code | planned | active | reserved | completed Binding: ?? (required): The status of the location. | |||||||||||
| physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: ?? (example): Physical form of the location. | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: ?? (example): Physical form of the location. | |||||||||||
| period | 0..1 | Period | Time period during which the patient was present at the location | 0..1 | Period | Time period during which the patient was present at the location | |||||||||||
| serviceProvider | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter |
| ||||||||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||||||||
| Documentation for this format | |||||||||||||||||