Clinical Practice Guidelines
2.0.0-ballot - ballot
Clinical Practice Guidelines
2.0.0-ballot - ballot
This page is part of the Clinical Guidelines (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-encounter | Version: 2.0.0-ballot | |||
| Active as of 2023-12-19 | Computable Name: CPGEncounter | |||
CPG encounter represents the minimum expectations for communicating encounter information as part of a CPG case
This is a domain case/instance profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter | Encounter | |||
  status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| class | S | 1..1 | Coding | Classification of patient encounter |
| type | S | 1..* | CodeableConcept | Specific type of encounter |
 subject | S | 0..1 | Reference(CPG Patient) | The patient or group present at the encounter |
| episodeOfCare | S | 0..* | Reference(CPG Case) | Episode(s) of care that this encounter should be recorded against |
 participant | S | 0..* | BackboneElement | List of participants involved in the encounter |
 type | S | 0..* | CodeableConcept | 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(CPG Practitioner | CPG Practitioner Role) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | S | 0..* | CodeableConcept | Coded reason the encounter takes place |
 location | S | 0..* | BackboneElement | List of locations where the patient has been |
 location | S | 1..1 | Reference(CPG Location) | Location the encounter takes place |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
 class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
| type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. |
| subject | SΣ | 0..1 | Reference(CPG Patient) | The patient or group present at the encounter |
| episodeOfCare | SΣ | 0..* | Reference(CPG Case) | Episode(s) of care that this encounter should be recorded against |
| participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
| 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(CPG Practitioner | CPG Practitioner Role) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
| location | S | 0..* | BackboneElement | List of locations where the patient has been |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| location | S | 1..1 | Reference(CPG Location) | Location the encounter takes place |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.status | required | EncounterStatus |
| Encounter.class | extensible | ActEncounterCode |
| Encounter.type | example | EncounterType |
| Encounter.participant.type | extensible | ParticipantType |
| Encounter.reasonCode | preferred | EncounterReasonCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | 0..* | Encounter | 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): A human language.
| |||||
| 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): 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: ActEncounterCode (extensible): Classification of the encounter. | ||||
| 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: EncounterType (example): The type of encounter. | ||||
| 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Σ | 0..1 | Reference(CPG Patient) | The patient or group present at the encounter | ||||
| episodeOfCare | SΣ | 0..* | Reference(CPG Case) | 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(CPG Practitioner | CPG Practitioner Role) | 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 | ||||
| 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 | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
| diagnosis | Σ | 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): The type of diagnosis this condition represents. | |||||
| 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 | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| 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 | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 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: 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 | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| 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(CPG 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 | 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| Encounter.language | preferred | CommonLanguages
| ||||
| Encounter.status | required | EncounterStatus | ||||
| Encounter.statusHistory.status | required | EncounterStatus | ||||
| Encounter.class | extensible | ActEncounterCode | ||||
| Encounter.classHistory.class | extensible | ActEncounterCode | ||||
| Encounter.type | example | EncounterType | ||||
| Encounter.serviceType | example | ServiceType | ||||
| Encounter.priority | example | ActPriority | ||||
| Encounter.participant.type | extensible | ParticipantType | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodes | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
| 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 | example | DischargeDisposition | ||||
| Encounter.location.status | required | EncounterLocationStatus | ||||
| Encounter.location.physicalType | example | LocationType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | Encounter | |||
| status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| class | S | 1..1 | Coding | Classification of patient encounter |
| type | S | 1..* | CodeableConcept | Specific type of encounter |
| subject | S | 0..1 | Reference(CPG Patient) | The patient or group present at the encounter |
| episodeOfCare | S | 0..* | Reference(CPG Case) | Episode(s) of care that this encounter should be recorded against |
| participant | S | 0..* | BackboneElement | List of participants involved in the encounter |
| type | S | 0..* | CodeableConcept | 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(CPG Practitioner | CPG Practitioner Role) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | S | 0..* | CodeableConcept | Coded reason the encounter takes place |
| location | S | 0..* | BackboneElement | List of locations where the patient has been |
| location | S | 1..1 | Reference(CPG Location) | Location the encounter takes place |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
| class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
| type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. |
| subject | SΣ | 0..1 | Reference(CPG Patient) | The patient or group present at the encounter |
| episodeOfCare | SΣ | 0..* | Reference(CPG Case) | Episode(s) of care that this encounter should be recorded against |
| participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
| 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(CPG Practitioner | CPG Practitioner Role) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
| location | S | 0..* | BackboneElement | List of locations where the patient has been |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| location | S | 1..1 | Reference(CPG Location) | Location the encounter takes place |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.status | required | EncounterStatus |
| Encounter.class | extensible | ActEncounterCode |
| Encounter.type | example | EncounterType |
| Encounter.participant.type | extensible | ParticipantType |
| Encounter.reasonCode | preferred | EncounterReasonCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | 0..* | Encounter | 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): A human language.
| |||||
| 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): 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: ActEncounterCode (extensible): Classification of the encounter. | ||||
| 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: EncounterType (example): The type of encounter. | ||||
| 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Σ | 0..1 | Reference(CPG Patient) | The patient or group present at the encounter | ||||
| episodeOfCare | SΣ | 0..* | Reference(CPG Case) | 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(CPG Practitioner | CPG Practitioner Role) | 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 | ||||
| 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 | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
| diagnosis | Σ | 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): The type of diagnosis this condition represents. | |||||
| 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 | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| 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 | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 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: 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 | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| 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(CPG 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 | 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| Encounter.language | preferred | CommonLanguages
| ||||
| Encounter.status | required | EncounterStatus | ||||
| Encounter.statusHistory.status | required | EncounterStatus | ||||
| Encounter.class | extensible | ActEncounterCode | ||||
| Encounter.classHistory.class | extensible | ActEncounterCode | ||||
| Encounter.type | example | EncounterType | ||||
| Encounter.serviceType | example | ServiceType | ||||
| Encounter.priority | example | ActPriority | ||||
| Encounter.participant.type | extensible | ParticipantType | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodes | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
| 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 | example | DischargeDisposition | ||||
| Encounter.location.status | required | EncounterLocationStatus | ||||
| Encounter.location.physicalType | example | LocationType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cpg#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change