Common Data Models Harmonization, published by HL7 International - Biomedical Research and Regulation Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cdmh/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-encounter |
Version: | 1.0.0 |
Name: | CdmhEncounter |
Title: | CDMH Encounter |
Status: | Draft as of 9/1/19 |
Definition: | This is the Encounter Resource profile for the IG. |
Publisher: | HL7 International - Biomedical Research and Regulation Work Group |
Copyright: | Used by permission of HL7, all rights reserved Creative Commons License |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-encounter
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from USCoreEncounterProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile | CDMH Encounter | |
cdmh-pcornet-drg-group | S | 0..1 | code | DRG Group URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group |
cdmh-pcornet-drg-group-version | S | 0..1 | code | PCORNet DRG Group Version URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group-version Binding: PCORNet DRG Group Version (extensible): Diagnosis Related Group Version codes for PCORNet data marts |
class | S | 1..1 | Coding | Classification of patient encounter Binding: PCORNet Encounter Type (extensible): Encounter type |
subject | S | 1..1 | Reference(CDMH Patient) | The patient or group present at the encounter |
period | ||||
start | S | 0..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
diagnosis | S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
cdmh-pcornet-diagnosis-origin | S | 0..1 | code | PCORNet Diagnosis Classification URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-diagnosis-origin Binding: PCORNet Information Source HC Subtype (extensible): From where did the diagnosis information come from within the healthcare organization |
condition | S | 1..1 | Reference(CDMH Condition) | The diagnosis or procedure relevant to the encounter |
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: PCORNet Diagnosis Classification (extensible): Diagnosis Classification codes for PCORNet Data Marts. |
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
cdmh-pcornet-admitting-source-facility-type | S | 0..1 | code | PCORNet Admitting Source Facility Type URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-admitting-source-facility-type Binding: PCORNet Admitting Source Facility Type (extensible): Admitting Source Facility Type for Inpatient Stays |
cdmh-pcornet-discharge-status | S | 0..1 | code | PCORNet Discharge Status URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-discharge-status Binding: PCORNet Discharge Status (extensible): Discharge Status of the Patient for Inpatient stays |
origin | S | 0..1 | Reference(CDMH Location) | The location/organization from which the patient came before admission |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: PCORNet Discharge Disposition (extensible): where the patient left the hospital |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
location | S | 1..1 | Reference(CDMH Location) | Location the encounter takes place |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile | CDMH Encounter | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cdmh-pcornet-drg-group | S | 0..1 | code | DRG Group URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group |
cdmh-pcornet-drg-group-version | S | 0..1 | code | PCORNet DRG Group Version URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group-version Binding: PCORNet DRG Group Version (extensible): Diagnosis Related Group Version codes for PCORNet data marts |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
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 | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 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) |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: PCORNet Encounter Type (extensible): Encounter type |
classHistory | 0..* | BackboneElement | List of past encounter classes | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |
subject | SΣ | 1..1 | Reference(CDMH Patient) | The patient or group present at the encounter |
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
period | S | 0..1 | Period | The start and end time of the encounter |
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 | |
start | SΣI | 0..1 | dateTime | Starting time with inclusive boundary |
end | SΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΣ | 0..1 | Reference(US Core Condition Profile S | US Core Procedure Profile | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
diagnosis | SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cdmh-pcornet-diagnosis-origin | S | 0..1 | code | PCORNet Diagnosis Classification URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-diagnosis-origin Binding: PCORNet Information Source HC Subtype (extensible): From where did the diagnosis information come from within the healthcare organization |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | SΣ | 1..1 | Reference(CDMH Condition) | The diagnosis or procedure relevant to the encounter |
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: PCORNet Diagnosis Classification (extensible): Diagnosis Classification codes for PCORNet Data Marts. |
rank | S | 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 | |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cdmh-pcornet-admitting-source-facility-type | S | 0..1 | code | PCORNet Admitting Source Facility Type URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-admitting-source-facility-type Binding: PCORNet Admitting Source Facility Type (extensible): Admitting Source Facility Type for Inpatient Stays |
cdmh-pcornet-discharge-status | S | 0..1 | code | PCORNet Discharge Status URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-discharge-status Binding: PCORNet Discharge Status (extensible): Discharge Status of the Patient for Inpatient stays |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | S | 0..1 | Reference(CDMH Location) | The location/organization from which the patient came before admission |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: PCORNet Discharge Disposition (extensible): where the patient left the hospital |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(CDMH Location) | Location the encounter takes place |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (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: LocationType (example): Physical form of the location. | |
period | 0..1 | Period | Time period during which the patient was present at the location | |
serviceProvider | S | 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 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile | CDMH Encounter | |
cdmh-pcornet-drg-group | 0..1 | code | DRG Group URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group | |
cdmh-pcornet-drg-group-version | 0..1 | code | PCORNet DRG Group Version URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group-version Binding: PCORNet DRG Group Version (extensible): Diagnosis Related Group Version codes for PCORNet data marts | |
identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known |
system | Σ | 1..1 | uri | The namespace for the identifier value |
value | Σ | 1..1 | string | The value that is unique |
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: PCORNet Encounter Type (extensible): Encounter type |
type | Σ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
subject | Σ | 1..1 | Reference(CDMH Patient) | The patient or group present at the encounter |
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter |
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | 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 |
period | 0..1 | Period | The start and end time of the encounter | |
start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | Σ | 0..1 | Reference(US Core Condition Profile) | Reason the encounter takes place (reference) |
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
cdmh-pcornet-diagnosis-origin | 0..1 | code | PCORNet Diagnosis Classification URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-diagnosis-origin Binding: PCORNet Information Source HC Subtype (extensible): From where did the diagnosis information come from within the healthcare organization | |
condition | Σ | 1..1 | Reference(CDMH Condition) | 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: PCORNet Diagnosis Classification (extensible): Diagnosis Classification codes for PCORNet Data Marts. | |
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |
hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |
cdmh-pcornet-admitting-source-facility-type | 0..1 | code | PCORNet Admitting Source Facility Type URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-admitting-source-facility-type Binding: PCORNet Admitting Source Facility Type (extensible): Admitting Source Facility Type for Inpatient Stays | |
cdmh-pcornet-discharge-status | 0..1 | code | PCORNet Discharge Status URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-discharge-status Binding: PCORNet Discharge Status (extensible): Discharge Status of the Patient for Inpatient stays | |
origin | 0..1 | Reference(CDMH Location) | The location/organization from which the patient came before admission | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: PCORNet Discharge Disposition (extensible): where the patient left the hospital | |
location | 0..* | BackboneElement | List of locations where the patient has been | |
location | 1..1 | Reference(CDMH Location) | Location the encounter takes place | |
serviceProvider | 0..1 | Reference(US Core Organization Profile) | The organization (facility) responsible for this encounter | |
Documentation for this format |
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreEncounterProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile | CDMH Encounter | |
cdmh-pcornet-drg-group | S | 0..1 | code | DRG Group URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group |
cdmh-pcornet-drg-group-version | S | 0..1 | code | PCORNet DRG Group Version URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group-version Binding: PCORNet DRG Group Version (extensible): Diagnosis Related Group Version codes for PCORNet data marts |
class | S | 1..1 | Coding | Classification of patient encounter Binding: PCORNet Encounter Type (extensible): Encounter type |
subject | S | 1..1 | Reference(CDMH Patient) | The patient or group present at the encounter |
period | ||||
start | S | 0..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
diagnosis | S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
cdmh-pcornet-diagnosis-origin | S | 0..1 | code | PCORNet Diagnosis Classification URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-diagnosis-origin Binding: PCORNet Information Source HC Subtype (extensible): From where did the diagnosis information come from within the healthcare organization |
condition | S | 1..1 | Reference(CDMH Condition) | The diagnosis or procedure relevant to the encounter |
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: PCORNet Diagnosis Classification (extensible): Diagnosis Classification codes for PCORNet Data Marts. |
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
cdmh-pcornet-admitting-source-facility-type | S | 0..1 | code | PCORNet Admitting Source Facility Type URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-admitting-source-facility-type Binding: PCORNet Admitting Source Facility Type (extensible): Admitting Source Facility Type for Inpatient Stays |
cdmh-pcornet-discharge-status | S | 0..1 | code | PCORNet Discharge Status URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-discharge-status Binding: PCORNet Discharge Status (extensible): Discharge Status of the Patient for Inpatient stays |
origin | S | 0..1 | Reference(CDMH Location) | The location/organization from which the patient came before admission |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: PCORNet Discharge Disposition (extensible): where the patient left the hospital |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
location | S | 1..1 | Reference(CDMH Location) | Location the encounter takes place |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile | CDMH Encounter | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cdmh-pcornet-drg-group | S | 0..1 | code | DRG Group URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group |
cdmh-pcornet-drg-group-version | S | 0..1 | code | PCORNet DRG Group Version URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-drg-group-version Binding: PCORNet DRG Group Version (extensible): Diagnosis Related Group Version codes for PCORNet data marts |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
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 | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 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) |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: PCORNet Encounter Type (extensible): Encounter type |
classHistory | 0..* | BackboneElement | List of past encounter classes | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |
subject | SΣ | 1..1 | Reference(CDMH Patient) | The patient or group present at the encounter |
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
period | S | 0..1 | Period | The start and end time of the encounter |
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 | |
start | SΣI | 0..1 | dateTime | Starting time with inclusive boundary |
end | SΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΣ | 0..1 | Reference(US Core Condition Profile S | US Core Procedure Profile | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
diagnosis | SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cdmh-pcornet-diagnosis-origin | S | 0..1 | code | PCORNet Diagnosis Classification URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-diagnosis-origin Binding: PCORNet Information Source HC Subtype (extensible): From where did the diagnosis information come from within the healthcare organization |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | SΣ | 1..1 | Reference(CDMH Condition) | The diagnosis or procedure relevant to the encounter |
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: PCORNet Diagnosis Classification (extensible): Diagnosis Classification codes for PCORNet Data Marts. |
rank | S | 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 | |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cdmh-pcornet-admitting-source-facility-type | S | 0..1 | code | PCORNet Admitting Source Facility Type URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-admitting-source-facility-type Binding: PCORNet Admitting Source Facility Type (extensible): Admitting Source Facility Type for Inpatient Stays |
cdmh-pcornet-discharge-status | S | 0..1 | code | PCORNet Discharge Status URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-discharge-status Binding: PCORNet Discharge Status (extensible): Discharge Status of the Patient for Inpatient stays |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | S | 0..1 | Reference(CDMH Location) | The location/organization from which the patient came before admission |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: PCORNet Discharge Disposition (extensible): where the patient left the hospital |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(CDMH Location) | Location the encounter takes place |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (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: LocationType (example): Physical form of the location. | |
period | 0..1 | Period | Time period during which the patient was present at the location | |
serviceProvider | S | 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 | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Encounter.language | preferred | CommonLanguages Max Binding: AllLanguages |
Encounter.identifier.use | required | IdentifierUse |
Encounter.identifier.type | extensible | Identifier Type Codes |
Encounter.status | required | EncounterStatus |
Encounter.statusHistory.status | required | EncounterStatus |
Encounter.class | extensible | PCORNetEncounterType |
Encounter.classHistory.class | extensible | ActEncounterCode |
Encounter.type | extensible | USCoreEncounterType |
Encounter.serviceType | example | ServiceType |
Encounter.priority | example | ActPriority |
Encounter.participant.type | extensible | ParticipantType |
Encounter.reasonCode | preferred | EncounterReasonCodes |
Encounter.diagnosis.use | extensible | PCORNetDiagnosisClassification |
Encounter.hospitalization.admitSource | preferred | AdmitSource |
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator |
Encounter.hospitalization.dietPreference | example | Diet |
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy |
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements |
Encounter.hospitalization.dischargeDisposition | extensible | PCORNetDischargeDisposition |
Encounter.location.status | required | EncounterLocationStatus |
Encounter.location.physicalType | example | LocationType |
Id | Path | Details | Requirements |
dom-2 | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Encounter.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.extension:pcornet-drg-group | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.extension:pcornet-drg-group | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.extension:pcornet-drg-group-version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.extension:pcornet-drg-group-version | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.statusHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.statusHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.statusHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.statusHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.statusHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.statusHistory.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.statusHistory.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.class | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.classHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.classHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.classHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.classHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.classHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.classHistory.class | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.classHistory.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.serviceType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.episodeOfCare | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.participant.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.participant.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.participant.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.participant.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant.individual | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.appointment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.period.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.period.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.period.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.period.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.length | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.diagnosis.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.diagnosis.extension:pcornet-diagnosis-origin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.diagnosis.extension:pcornet-diagnosis-origin | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.diagnosis.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.diagnosis.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.diagnosis.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.account | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.extension:pcornet-admitting-source-facility-type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.extension:pcornet-admitting-source-facility-type | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.extension:pcornet-discharge-status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.extension:pcornet-discharge-status | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.preAdmissionIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.origin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.admitSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.reAdmission | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.dietPreference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.specialCourtesy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.specialArrangement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.destination | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.dischargeDisposition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.location.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.location.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.location.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.location.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.physicalType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.serviceProvider | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |