Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1 | Version: 0.1.0 | |||
Draft as of 2018-11-05 | Computable Name: CareConnect-Encounter-1 | |||
Copyright/Legal: Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html |
The encounter resource represents an encounter between a care professional and the patient (or patient’s record).
CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/
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 | 0..* | Encounter | An interaction during which services are provided to the patient | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounterTransport | 0..1 | (Complex) | Encounter transport URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 | |
outcomeOfAttendance | 0..1 | CodeableConcept | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 Binding: NHS Data Model and Dictionary Outcome Of Attendance (required): This records the outcome of an Out-Patient Attendance Consultant. | |
emergencyCareDischargeStatus | 0..1 | CodeableConcept | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EmergencyCareDischargeStatus-1 Binding: Care Connect Emergency Care Discharge Status (required): The status of the Patient on discharge from an Emergency Care Department. | |
identifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
class | 0..1 | Coding | Classification of the encounter | |
classHistory | ||||
class | 1..1 | Coding | Classification of the encounter | |
type | ||||
Slices for coding | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Encounter Type (extensible): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
subject | 0..1 | Reference(Group | CareConnectPatient1) | The patient ro group present at the encounter | |
participant | ||||
individual | 0..1 | Reference(RelatedPerson | CareConnect-Practitioner-1) | Persons involved in the encounter other than the patient | |
reason | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
diagnosis | ||||
condition | 1..1 | Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) | Reason the encounter takes place (resource) | |
hospitalization | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
admissionMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record how a Patient was admitted to hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 Binding: NHS Data Model and Dictionary Admission Method (required): The method of admission to a Hospital Provider Spell. | |
dischargeMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record the method of discharge from hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-1 Binding: NHS Data Model and Dictionary Discharge Method (required): The method of discharge from a Hospital Provider Spell. | |
preAdmissionIdentifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
origin | 0..1 | Reference(CareConnect-Location-1) | The location from which the patient came before admission | |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: NHS Data Model and Dictionary Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. | |
reAdmission | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (extensible) | |
destination | 0..1 | Reference(CareConnect-Location-1) | Location to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: NHS Data Model and Dictionary Discharge Destination (example): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. | |
location | ||||
location | 1..1 | Reference(CareConnect-Location-1) | Location the encounter takes place | |
serviceProvider | 0..1 | Reference(CareConnect-Organization-1) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(CareConnect-Encounter-1) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet |
Encounter.type.coding:snomedCT | extensible | Care Connect Encounter Type |
Encounter.hospitalization.admitSource | preferred | NHS Data Model and Dictionary Source Of Admission |
Encounter.hospitalization.dietPreference | extensible | Diet |
Encounter.hospitalization.dischargeDisposition | example | NHS Data Model and Dictionary Discharge Destination |
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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounterTransport | 0..1 | (Complex) | Encounter transport URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 | |
outcomeOfAttendance | 0..1 | CodeableConcept | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 Binding: NHS Data Model and Dictionary Outcome Of Attendance (required): This records the outcome of an Out-Patient Attendance Consultant. | |
emergencyCareDischargeStatus | 0..1 | CodeableConcept | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EmergencyCareDischargeStatus-1 Binding: Care Connect Emergency Care Discharge Status (required): The status of the Patient on discharge from an Emergency Care Department. | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter |
class | Σ | 0..1 | Coding | Classification of the encounter Binding: ActEncounterCode (extensible): Classification of the encounter |
subject | Σ | 0..1 | Reference(Group | CareConnectPatient1) | The patient ro group present at the encounter |
serviceProvider | 0..1 | Reference(CareConnect-Organization-1) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(CareConnect-Encounter-1) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet |
Encounter.status | required | EncounterStatus |
Encounter.class | extensible | ActEncounterCode |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
ele-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus | 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: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
encounterTransport | 0..1 | (Complex) | Encounter transport URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 | |||||
outcomeOfAttendance | 0..1 | CodeableConcept | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 Binding: NHS Data Model and Dictionary Outcome Of Attendance (required): This records the outcome of an Out-Patient Attendance Consultant. | |||||
emergencyCareDischargeStatus | 0..1 | CodeableConcept | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EmergencyCareDischargeStatus-1 Binding: Care Connect Emergency Care Discharge Status (required): The status of the Patient on discharge from an Emergency Care Department. | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 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 | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
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 | Σ | 0..1 | Coding | Classification of the encounter Binding: ActEncounterCode (extensible): Classification of the encounter | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
class | 1..1 | Coding | Classification of the encounter Binding: ActEncounterCode (extensible): Classification of the encounter | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Encounter Type (extensible): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | Σ | 0..1 | Reference(Group | CareConnectPatient1) | The patient ro group present at the encounter | ||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter | |||||
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter | ||||
period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
individual | Σ | 0..1 | Reference(RelatedPerson | CareConnect-Practitioner-1) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | 0..1 | Period | The start and end time of the encounter | |||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reason | Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred): Reason why the encounter takes place. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
condition | 1..1 | Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) | Reason the encounter takes place (resource) | |||||
role | 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 | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
admissionMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record how a Patient was admitted to hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 Binding: NHS Data Model and Dictionary Admission Method (required): The method of admission to a Hospital Provider Spell. | |||||
dischargeMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record the method of discharge from hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-1 Binding: NHS Data Model and Dictionary Discharge Method (required): The method of discharge from a Hospital Provider Spell. | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
origin | 0..1 | Reference(CareConnect-Location-1) | The location from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: NHS Data Model and Dictionary Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. | |||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: v2 Re-Admission Indicator (example): The reason for re-admission of this hospitalization encounter. | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (extensible) | |||||
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(CareConnect-Location-1) | Location to which the patient is discharged | |||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: NHS Data Model and Dictionary Discharge Destination (example): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
location | 1..1 | Reference(CareConnect-Location-1) | Location the encounter takes place | |||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | 0..1 | Reference(CareConnect-Organization-1) | The custodian organization of this Encounter record | |||||
partOf | 0..1 | Reference(CareConnect-Encounter-1) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Encounter.language | extensible | Common Languages
| ||||
Encounter.identifier.use | required | IdentifierUse | ||||
Encounter.identifier.type | extensible | Identifier Type Codes | ||||
Encounter.status | required | EncounterStatus | ||||
Encounter.statusHistory.status | required | EncounterStatus | ||||
Encounter.class | extensible | ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCode | ||||
Encounter.type | example | EncounterType | ||||
Encounter.type.coding:snomedCT | extensible | Care Connect Encounter Type | ||||
Encounter.priority | example | v3 Code System ActPriority | ||||
Encounter.participant.type | extensible | ParticipantType | ||||
Encounter.reason | preferred | Encounter Reason Codes | ||||
Encounter.diagnosis.role | preferred | DiagnosisRole | ||||
Encounter.hospitalization.preAdmissionIdentifier.use | required | IdentifierUse | ||||
Encounter.hospitalization.preAdmissionIdentifier.type | extensible | Identifier Type Codes | ||||
Encounter.hospitalization.admitSource | preferred | NHS Data Model and Dictionary Source Of Admission | ||||
Encounter.hospitalization.reAdmission | example | v2 Re-Admission Indicator | ||||
Encounter.hospitalization.dietPreference | extensible | Diet | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
Encounter.hospitalization.dischargeDisposition | example | NHS Data Model and Dictionary Discharge Destination | ||||
Encounter.location.status | required | EncounterLocationStatus |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus, Encounter.statusHistory, Encounter.classHistory, Encounter.participant, Encounter.diagnosis, Encounter.hospitalization, Encounter.hospitalization.extension:admissionMethod, Encounter.hospitalization.extension:dischargeMethod, Encounter.location | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus, Encounter.hospitalization.extension:admissionMethod, Encounter.hospitalization.extension:dischargeMethod | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 0 element (13 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounterTransport | 0..1 | (Complex) | Encounter transport URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 | |
outcomeOfAttendance | 0..1 | CodeableConcept | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 Binding: NHS Data Model and Dictionary Outcome Of Attendance (required): This records the outcome of an Out-Patient Attendance Consultant. | |
emergencyCareDischargeStatus | 0..1 | CodeableConcept | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EmergencyCareDischargeStatus-1 Binding: Care Connect Emergency Care Discharge Status (required): The status of the Patient on discharge from an Emergency Care Department. | |
identifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
class | 0..1 | Coding | Classification of the encounter | |
classHistory | ||||
class | 1..1 | Coding | Classification of the encounter | |
type | ||||
Slices for coding | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Encounter Type (extensible): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
subject | 0..1 | Reference(Group | CareConnectPatient1) | The patient ro group present at the encounter | |
participant | ||||
individual | 0..1 | Reference(RelatedPerson | CareConnect-Practitioner-1) | Persons involved in the encounter other than the patient | |
reason | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
diagnosis | ||||
condition | 1..1 | Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) | Reason the encounter takes place (resource) | |
hospitalization | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
admissionMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record how a Patient was admitted to hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 Binding: NHS Data Model and Dictionary Admission Method (required): The method of admission to a Hospital Provider Spell. | |
dischargeMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record the method of discharge from hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-1 Binding: NHS Data Model and Dictionary Discharge Method (required): The method of discharge from a Hospital Provider Spell. | |
preAdmissionIdentifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
origin | 0..1 | Reference(CareConnect-Location-1) | The location from which the patient came before admission | |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: NHS Data Model and Dictionary Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. | |
reAdmission | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (extensible) | |
destination | 0..1 | Reference(CareConnect-Location-1) | Location to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: NHS Data Model and Dictionary Discharge Destination (example): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. | |
location | ||||
location | 1..1 | Reference(CareConnect-Location-1) | Location the encounter takes place | |
serviceProvider | 0..1 | Reference(CareConnect-Organization-1) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(CareConnect-Encounter-1) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet |
Encounter.type.coding:snomedCT | extensible | Care Connect Encounter Type |
Encounter.hospitalization.admitSource | preferred | NHS Data Model and Dictionary Source Of Admission |
Encounter.hospitalization.dietPreference | extensible | Diet |
Encounter.hospitalization.dischargeDisposition | example | NHS Data Model and Dictionary Discharge Destination |
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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounterTransport | 0..1 | (Complex) | Encounter transport URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 | |
outcomeOfAttendance | 0..1 | CodeableConcept | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 Binding: NHS Data Model and Dictionary Outcome Of Attendance (required): This records the outcome of an Out-Patient Attendance Consultant. | |
emergencyCareDischargeStatus | 0..1 | CodeableConcept | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EmergencyCareDischargeStatus-1 Binding: Care Connect Emergency Care Discharge Status (required): The status of the Patient on discharge from an Emergency Care Department. | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter |
class | Σ | 0..1 | Coding | Classification of the encounter Binding: ActEncounterCode (extensible): Classification of the encounter |
subject | Σ | 0..1 | Reference(Group | CareConnectPatient1) | The patient ro group present at the encounter |
serviceProvider | 0..1 | Reference(CareConnect-Organization-1) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(CareConnect-Encounter-1) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet |
Encounter.status | required | EncounterStatus |
Encounter.class | extensible | ActEncounterCode |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
ele-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus | 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: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
encounterTransport | 0..1 | (Complex) | Encounter transport URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 | |||||
outcomeOfAttendance | 0..1 | CodeableConcept | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 Binding: NHS Data Model and Dictionary Outcome Of Attendance (required): This records the outcome of an Out-Patient Attendance Consultant. | |||||
emergencyCareDischargeStatus | 0..1 | CodeableConcept | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EmergencyCareDischargeStatus-1 Binding: Care Connect Emergency Care Discharge Status (required): The status of the Patient on discharge from an Emergency Care Department. | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 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 | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
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 | Σ | 0..1 | Coding | Classification of the encounter Binding: ActEncounterCode (extensible): Classification of the encounter | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
class | 1..1 | Coding | Classification of the encounter Binding: ActEncounterCode (extensible): Classification of the encounter | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Encounter Type (extensible): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | Σ | 0..1 | Reference(Group | CareConnectPatient1) | The patient ro group present at the encounter | ||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter | |||||
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter | ||||
period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
individual | Σ | 0..1 | Reference(RelatedPerson | CareConnect-Practitioner-1) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | 0..1 | Period | The start and end time of the encounter | |||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reason | Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred): Reason why the encounter takes place. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
condition | 1..1 | Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) | Reason the encounter takes place (resource) | |||||
role | 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 | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
admissionMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record how a Patient was admitted to hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 Binding: NHS Data Model and Dictionary Admission Method (required): The method of admission to a Hospital Provider Spell. | |||||
dischargeMethod | 0..1 | CodeableConcept | An extension to the Encounter resource to record the method of discharge from hospital. URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-1 Binding: NHS Data Model and Dictionary Discharge Method (required): The method of discharge from a Hospital Provider Spell. | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
origin | 0..1 | Reference(CareConnect-Location-1) | The location from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: NHS Data Model and Dictionary Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. | |||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: v2 Re-Admission Indicator (example): The reason for re-admission of this hospitalization encounter. | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (extensible) | |||||
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(CareConnect-Location-1) | Location to which the patient is discharged | |||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: NHS Data Model and Dictionary Discharge Destination (example): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
location | 1..1 | Reference(CareConnect-Location-1) | Location the encounter takes place | |||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | 0..1 | Reference(CareConnect-Organization-1) | The custodian organization of this Encounter record | |||||
partOf | 0..1 | Reference(CareConnect-Encounter-1) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Encounter.language | extensible | Common Languages
| ||||
Encounter.identifier.use | required | IdentifierUse | ||||
Encounter.identifier.type | extensible | Identifier Type Codes | ||||
Encounter.status | required | EncounterStatus | ||||
Encounter.statusHistory.status | required | EncounterStatus | ||||
Encounter.class | extensible | ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCode | ||||
Encounter.type | example | EncounterType | ||||
Encounter.type.coding:snomedCT | extensible | Care Connect Encounter Type | ||||
Encounter.priority | example | v3 Code System ActPriority | ||||
Encounter.participant.type | extensible | ParticipantType | ||||
Encounter.reason | preferred | Encounter Reason Codes | ||||
Encounter.diagnosis.role | preferred | DiagnosisRole | ||||
Encounter.hospitalization.preAdmissionIdentifier.use | required | IdentifierUse | ||||
Encounter.hospitalization.preAdmissionIdentifier.type | extensible | Identifier Type Codes | ||||
Encounter.hospitalization.admitSource | preferred | NHS Data Model and Dictionary Source Of Admission | ||||
Encounter.hospitalization.reAdmission | example | v2 Re-Admission Indicator | ||||
Encounter.hospitalization.dietPreference | extensible | Diet | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
Encounter.hospitalization.dischargeDisposition | example | NHS Data Model and Dictionary Discharge Destination | ||||
Encounter.location.status | required | EncounterLocationStatus |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus, Encounter.statusHistory, Encounter.classHistory, Encounter.participant, Encounter.diagnosis, Encounter.hospitalization, Encounter.hospitalization.extension:admissionMethod, Encounter.hospitalization.extension:dischargeMethod, Encounter.location | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Encounter.extension:encounterTransport, Encounter.extension:outcomeOfAttendance, Encounter.extension:emergencyCareDischargeStatus, Encounter.hospitalization.extension:admissionMethod, Encounter.hospitalization.extension:dischargeMethod | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 0 element (13 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron