Care Coordination and 360 Referrals (Proof of Concept)
0.1.0 - proof-of-concept
Care Coordination and 360 Referrals (Proof of Concept) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/Visit | Version: 0.1.0 | ||||
| Draft as of 2026-11-03 | Computable Name: Visit | ||||
Patient Administration - an attendance or contact, identified by the
Visit Number: an A&E attendance, an outpatient
attendance, a community contact, or a stay within a spell. partOf the
Hospital Spell when it is part of an admission.
Equivalent to the Interweave Encounter.
Copied from the NW GMSA FHIR IG.
Equivalent FDP Canonical Data Model (CDM) v1.0.0 objects: Appointment, Outpatient Activity, Virtual Ward Stay.
Differences:
attendanceId, appointmentExternalId and cdsUniqueId - To confirm.partOf).The CDM is a downstream persistence model, used here as evidence of what NHS operations record, not as a design source. Mapping by property name - To confirm. See FDP Canonical Data Model Mapping for the full mapping.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | CorrelationIdentifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | VisitNumber | Visit Number (HL7 v2 type VN) | |
![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
![]() ![]() |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |
![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | |
![]() ![]() |
0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |
![]() ![]() |
1..1 | Reference(Patient) | The patient or group present at the encounter | |
![]() ![]() |
0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
![]() ![]() |
0..* | Reference(ServiceRequest) | The referral this encounter carries out | |
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type.coding Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() |
0..* | Reference(Appointment) | The appointment that scheduled this encounter | |
![]() ![]() |
0..1 | Period | The start and end time of the encounter | |
![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() |
0..1 | Reference(Hospital Spell) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
0..1 | HospitalProviderSpellIdentifier | Logical reference, when literal reference is not known | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.5 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | VisitNumber | Visit Number (HL7 v2 type VN) | |
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type.coding Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Role of participant in encounter | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() |
0..1 | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |
![]() ![]() |
0..1 | Reference(Hospital Spell) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
0..1 | HospitalProviderSpellIdentifier | Logical reference, when literal reference is not known | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..* | CorrelationIdentifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | VisitNumber | Visit Number (HL7 v2 type VN) | |||||
![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | |||||
![]() ![]() |
0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
1..1 | Reference(Patient) | The patient or group present at the encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The referral this encounter carries out | |||||
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type.coding Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
![]() ![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | List of participants involved in the encounter | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..* | Reference(Appointment) | The appointment that scheduled this encounter | |||||
![]() ![]() |
0..1 | Period | The start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |||||
![]() ![]() |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | |||||
![]() ![]() |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..1 | Reference(Hospital Spell) | Another Encounter this encounter is part of | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
0..1 | HospitalProviderSpellIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.5 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.5 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.5 |
| Encounter.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:consultingDoctor.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:consultingDoctor.individual.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.participant:attendingDoctor.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:attendingDoctor.individual.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.5 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceProvider.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.partOf.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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: 0 element(3 nested mandatory elements)
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | CorrelationIdentifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | VisitNumber | Visit Number (HL7 v2 type VN) | |
![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
![]() ![]() |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |
![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | |
![]() ![]() |
0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |
![]() ![]() |
1..1 | Reference(Patient) | The patient or group present at the encounter | |
![]() ![]() |
0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
![]() ![]() |
0..* | Reference(ServiceRequest) | The referral this encounter carries out | |
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type.coding Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() |
0..* | Reference(Appointment) | The appointment that scheduled this encounter | |
![]() ![]() |
0..1 | Period | The start and end time of the encounter | |
![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() |
0..1 | Reference(Hospital Spell) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
0..1 | HospitalProviderSpellIdentifier | Logical reference, when literal reference is not known | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.5 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | VisitNumber | Visit Number (HL7 v2 type VN) | |
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type.coding Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Role of participant in encounter | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() |
0..1 | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |
![]() ![]() |
0..1 | Reference(Hospital Spell) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
0..1 | HospitalProviderSpellIdentifier | Logical reference, when literal reference is not known | |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..* | CorrelationIdentifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | VisitNumber | Visit Number (HL7 v2 type VN) | |||||
![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | |||||
![]() ![]() |
0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
1..1 | Reference(Patient) | The patient or group present at the encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The referral this encounter carries out | |||||
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type.coding Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
![]() ![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | List of participants involved in the encounter | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Required Pattern: | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | PractitionerIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..* | Reference(Appointment) | The appointment that scheduled this encounter | |||||
![]() ![]() |
0..1 | Period | The start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |||||
![]() ![]() |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | |||||
![]() ![]() |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..1 | Reference(Hospital Spell) | Another Encounter this encounter is part of | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
0..1 | HospitalProviderSpellIdentifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.5 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.5 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.5 |
| Encounter.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:consultingDoctor.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:consultingDoctor.individual.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.participant:attendingDoctor.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:attendingDoctor.individual.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.5 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceProvider.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.partOf.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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: 0 element(3 nested mandatory elements)
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron