This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-encounter
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | I | 0..* | An interaction during which services are provided to the patient | |
id | Σ | 0..1 | id | 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 | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) Fixed Value: planned |
statusHistory | I | 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) | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: V3 Value SetActEncounterCode (extensible) |
classHistory | I | 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: V3 Value SetActEncounterCode (extensible) | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example) |
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example) |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: v3 Code System ActPriority (example) | |
subject | Σ | 0..1 | Reference(Patient | Group) | 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 | ΣI | 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 | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible) |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
period | 0..1 | Period | The start and end time of the encounter | |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred) |
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this 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 |
condition | Σ | 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: DiagnosisRole (preferred) | |
rank | 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 | SI | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-patientStatus | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus |
extension-nursingHomeResidentialStatus | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |
admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred) |
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: v2 RE-ADMISSION INDICATOR (example) | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example) | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred) | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred) | |
destination | 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: DischargeDisposition (example) | |
location | I | 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 | 1..1 | Reference(Location) | Location the encounter takes place | |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required) | |
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example) | |
period | 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 | |
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
Documentation for this format |
This structure is derived from Encounter
Differential View
This structure is derived from Encounter
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | I | 0..* | An interaction during which services are provided to the patient | |
id | Σ | 0..1 | id | 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 | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) Fixed Value: planned |
statusHistory | I | 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) | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: V3 Value SetActEncounterCode (extensible) |
classHistory | I | 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: V3 Value SetActEncounterCode (extensible) | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example) |
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example) |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: v3 Code System ActPriority (example) | |
subject | Σ | 0..1 | Reference(Patient | Group) | 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 | ΣI | 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 | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible) |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
period | 0..1 | Period | The start and end time of the encounter | |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred) |
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this 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 |
condition | Σ | 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: DiagnosisRole (preferred) | |
rank | 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 | SI | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-patientStatus | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus |
extension-nursingHomeResidentialStatus | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |
admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred) |
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: v2 RE-ADMISSION INDICATOR (example) | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example) | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred) | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred) | |
destination | 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: DischargeDisposition (example) | |
location | I | 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 | 1..1 | Reference(Location) | Location the encounter takes place | |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required) | |
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example) | |
period | 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 | |
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Encounter.language | preferred | CommonLanguages Max Binding: AllLanguages |
Encounter.status | required | Fixed Value: planned |
Encounter.statusHistory.status | required | EncounterStatus |
Encounter.class | extensible | v3.ActEncounterCode |
Encounter.classHistory.class | extensible | v3.ActEncounterCode |
Encounter.type | example | EncounterType |
Encounter.serviceType | example | ServiceType |
Encounter.priority | example | v3.ActPriority |
Encounter.participant.type | extensible | ParticipantType |
Encounter.reasonCode | preferred | EncounterReasonCodes |
Encounter.diagnosis.use | preferred | DiagnosisRole |
Encounter.hospitalization.admitSource | preferred | AdmitSource |
Encounter.hospitalization.reAdmission | example | v2.0092 |
Encounter.hospitalization.dietPreference | example | Diet |
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy |
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements |
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition |
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-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-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-6 | Encounter | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
ele-1 | Encounter.statusHistory | 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.participant | 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.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 | 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 | 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.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |