Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweaveEncounterGrouping

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-EncounterGrouping Version: 0.1.0
Active as of 2024-02-19 Computable Name: InterweaveEncounterGrouping

Interweave Encounter resource profile to group other encounters into a ‘visit’

  Status: Active: Approved (STU)

Introduction

This profile describes the use of an Encounter resource to provide an overarching “Encounter Grouping”. The purpose is to link together several underlying more detailed Encounters, thus representing the concept of a “visit”, “stay”, or “incident”.

Please refer to the main Encounter Resource profile for a more complete description of the approach to modelling Encounters

The EncounterGrouping is a skeletal Encounter which requires a small number of mandatory fields:

  • Class - a new class code of GROUPING is defined specifically to identify these overarching Encounters
  • Status - mandatory in FHIR
  • Period - the period of the overall “visit”
  • Subject - the Patient involved

In addition as Must Support:

  • Identifier - a local id if relevant
  • Hospitalization - information about admission and discharge. (Collating together information already provided on the underlying Encounters). See the Encounter Resource Profile for further details of this structure.

Most other fields are removed, as this detail should instead be captured on the underlying Encounter records.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CareConnect-Encounter-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*CareConnect-Encounter-1An interaction during which services are provided to the patient
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:encounterTransport 0..0
... extension:outcomeOfAttendance 0..0
... extension:emergencyCareDischargeStatus 0..0
... Slices for identifier 0..*IdentifierIdentifier(s) by which this encounter is known
Slice: Unordered, Open by value:system
.... identifier:localIdentifier S0..1IdentifierIdentifier(s) by which this encounter is known
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-encounter-identifier
..... value S1..1stringThe Local encounter Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... status S1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S1..1CodingClassification of the encounter
Binding: InterweaveEncounterClass (required)
Fixed Value: As shown
.... system1..1uriIdentity of the terminology system
Fixed Value: https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-EncounterClass-1
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: GROUPING
.... display1..1stringRepresentation defined by the system
Fixed Value: Grouping of related Encounters
.... system 1..1uriIdentity of the terminology system
.... code 1..1codeSymbol in syntax defined by the system
.... display 1..1stringRepresentation defined by the system
... classHistory 0..0
... type 0..0
... priority 0..0
... subject S1..1Reference(CareConnectPatient1)The patient (NOT group) present at the encounter
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... episodeOfCare 0..0
... incomingReferral 0..0
... participant 0..0
... appointment 0..0
... period S1..1PeriodThe start and end time of the encounter
.... start S1..1dateTimeStarting time with inclusive boundary
.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
... length 0..1DurationDISCOURAGED: This duplicates information that is already available via the Period
... reason 0..0
... diagnosis 0..0
... account 0..0
... hospitalization S0..1BackboneElementDetails about the admission to a healthcare service
.... extension:admissionMethod S0..1Extension-CareConnect-AdmissionMethod-1An extension to the Encounter resource to record how a Patient was admitted to hospital.
.... extension:dischargeMethod S0..1Extension-CareConnect-DischargeMethod-1An extension to the Encounter resource to record the method of discharge from hospital.
.... medicallySafeForDischarge S0..1(Complex)Medically Safe for Discharge
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-MedicallySafeForDischarge
.... origin 0..1Reference(CareConnect-Location-1)The location from which the patient came before admission. Useful to provide if possible, in particular to reference a 'site' if transfered from another institution.
..... reference 1..1stringReference to a resource (could be Contained)
..... identifier 0..1IdentifierIf relevant could include an id
..... display 1..1stringDescription of the referenced resource
.... admitSource S0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: NHS Data Model and Dictionary Source Of Admission (required)
..... coding
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
.... dietPreference 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
.... specialCourtesy 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
.... specialArrangement 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
.... destination S0..1Reference(CareConnect-Location-1)Location to which the patient is discharged. Important to provide if known to support discharge planning, and/or to reference a 'site' if transfered to another institution.
..... reference 1..1stringReference to a resource (could be Contained)
..... identifier 0..1IdentifierIf relevant could include an id
..... display 1..1stringDescription of the referenced resource
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: Interweave Discharge Destination codes (required)
..... coding
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... location 0..0
... serviceProvider 0..1Reference(CareConnect-Organization-1)DISCOURAGED: This is instead covered via the provenance tags
... partOf 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Encounter.classrequiredFixed Value: GROUPING("Grouping of related Encounters")
Encounter.hospitalization.admitSourcerequiredNHS Data Model and Dictionary Source Of Admission
Encounter.hospitalization.dischargeDispositionrequiredInterweave Discharge Destination codes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*CareConnect-Encounter-1An interaction during which services are provided to the patient
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
.... identifier:localIdentifier SΣ0..1IdentifierIdentifier(s) by which this encounter is known
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-encounter-identifier
..... value SΣ1..1stringThe Local encounter Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter

... class SΣ1..1CodingClassification of the encounter
Binding: InterweaveEncounterClass (required)
Fixed Value: As shown
.... id0..0stringxml:id (or equivalent in JSON)
.... extension0..0ExtensionAdditional Content defined by implementations
.... system1..1uriIdentity of the terminology system
Fixed Value: https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-EncounterClass-1
.... version0..0stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: GROUPING
.... display1..1stringRepresentation defined by the system
Fixed Value: Grouping of related Encounters
.... userSelected0..0booleanIf this coding was chosen directly by the user
.... system Σ1..1uriIdentity of the terminology system
.... code Σ1..1codeSymbol in syntax defined by the system
.... display Σ1..1stringRepresentation defined by the system
... subject SΣ1..1Reference(CareConnectPatient1)The patient (NOT group) present at the encounter
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... period S1..1PeriodThe start and end time of the encounter
.... start SΣC1..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... length 0..1DurationDISCOURAGED: This duplicates information that is already available via the Period
... hospitalization S0..1BackboneElementDetails about the admission to a healthcare service
.... admissionMethod S0..1CodeableConceptAn 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 S0..1CodeableConceptAn 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.


.... medicallySafeForDischarge S0..1(Complex)Medically Safe for Discharge
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-MedicallySafeForDischarge
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... origin 0..1Reference(CareConnect-Location-1)The location from which the patient came before admission. Useful to provide if possible, in particular to reference a 'site' if transfered from another institution.
..... reference ΣC1..1stringReference to a resource (could be Contained)
..... identifier Σ0..1IdentifierIf relevant could include an id
..... display Σ1..1stringDescription of the referenced resource
.... admitSource S0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: NHS Data Model and Dictionary Source Of Admission (required)
.... dietPreference 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: Diet (extensible)
.... specialCourtesy 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: SpecialCourtesy (preferred): Special courtesies


.... specialArrangement 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: SpecialArrangements (preferred): Special arrangements


.... destination S0..1Reference(CareConnect-Location-1)Location to which the patient is discharged. Important to provide if known to support discharge planning, and/or to reference a 'site' if transfered to another institution.
..... reference ΣC1..1stringReference to a resource (could be Contained)
..... identifier Σ0..1IdentifierIf relevant could include an id
..... display Σ1..1stringDescription of the referenced resource
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: Interweave Discharge Destination codes (required)
... serviceProvider 0..1Reference(CareConnect-Organization-1)DISCOURAGED: This is instead covered via the provenance tags

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.meta.securityextensibleAll Security Labels
Encounter.meta.tagexampleCommon Tags
Encounter.meta.tag:SourceexampleCommon Tags
Encounter.meta.tag:ProvenanceexampleCommon Tags
Encounter.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.identifier.userequiredIdentifierUse
Encounter.identifier:localIdentifier.userequiredIdentifierUse
Encounter.statusrequiredEncounterStatus
Encounter.classrequiredFixed Value: GROUPING("Grouping of related Encounters")
Encounter.classHistory.classextensibleActEncounterCode
Encounter.type.coding:snomedCTextensibleCare Connect Encounter Type
Encounter.hospitalization.admitSourcerequiredNHS Data Model and Dictionary Source Of Admission
Encounter.hospitalization.dietPreferenceextensibleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionrequiredInterweave Discharge Destination codes

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEncounterIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorEncounter.hospitalization.extension:admissionMethod, Encounter.hospitalization.extension:dischargeMethodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*CareConnect-Encounter-1An interaction during which services are provided to the patient
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier SΣ0..1IdentifierIdentifier(s) by which this encounter is known
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-encounter-identifier
..... value SΣ1..1stringThe Local encounter Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter

... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter

.... period 1..1PeriodThe time that the episode was in the specified status
... class SΣ1..1CodingClassification of the encounter
Binding: InterweaveEncounterClass (required)
Fixed Value: As shown
.... id0..0stringxml:id (or equivalent in JSON)
.... extension0..0ExtensionAdditional Content defined by implementations
.... system1..1uriIdentity of the terminology system
Fixed Value: https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-EncounterClass-1
.... version0..0stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: GROUPING
.... display1..1stringRepresentation defined by the system
Fixed Value: Grouping of related Encounters
.... userSelected0..0booleanIf this coding was chosen directly by the user
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ1..1uriIdentity of the terminology system
.... version Σ0..1stringVersion of the system - if relevant
.... code Σ1..1codeSymbol in syntax defined by the system
.... display Σ1..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... subject SΣ1..1Reference(CareConnectPatient1)The patient (NOT group) present at the encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... period S1..1PeriodThe start and end time of the encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC1..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... length 0..1DurationDISCOURAGED: This duplicates information that is already available via the Period
... hospitalization S0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... admissionMethod S0..1CodeableConceptAn 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 S0..1CodeableConceptAn 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.


.... medicallySafeForDischarge S0..1(Complex)Medically Safe for Discharge
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-MedicallySafeForDischarge
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... origin 0..1Reference(CareConnect-Location-1)The location from which the patient came before admission. Useful to provide if possible, in particular to reference a 'site' if transfered from another institution.
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringReference to a resource (could be Contained)
..... identifier Σ0..1IdentifierIf relevant could include an id
..... display Σ1..1stringDescription of the referenced resource
.... admitSource S0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: NHS Data Model and Dictionary Source Of Admission (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... reAdmission 0..1CodeableConceptThe 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..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
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..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... dietPreference 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: Diet (extensible)
.... specialCourtesy 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: SpecialCourtesy (preferred): Special courtesies


.... specialArrangement 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: SpecialArrangements (preferred): Special arrangements


.... destination S0..1Reference(CareConnect-Location-1)Location to which the patient is discharged. Important to provide if known to support discharge planning, and/or to reference a 'site' if transfered to another institution.
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringReference to a resource (could be Contained)
..... identifier Σ0..1IdentifierIf relevant could include an id
..... display Σ1..1stringDescription of the referenced resource
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: Interweave Discharge Destination codes (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... serviceProvider 0..1Reference(CareConnect-Organization-1)DISCOURAGED: This is instead covered via the provenance tags

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.meta.securityextensibleAll Security Labels
Encounter.meta.tagexampleCommon Tags
Encounter.meta.tag:SourceexampleCommon Tags
Encounter.meta.tag:ProvenanceexampleCommon Tags
Encounter.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.identifier.userequiredIdentifierUse
Encounter.identifier.typeextensibleIdentifier Type Codes
Encounter.identifier:localIdentifier.userequiredIdentifierUse
Encounter.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Encounter.statusrequiredEncounterStatus
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classrequiredFixed Value: GROUPING("Grouping of related Encounters")
Encounter.classHistory.classextensibleActEncounterCode
Encounter.type.coding:snomedCTextensibleCare Connect Encounter Type
Encounter.participant.typeextensibleParticipantType
Encounter.diagnosis.rolepreferredDiagnosisRole
Encounter.hospitalization.preAdmissionIdentifier.userequiredIdentifierUse
Encounter.hospitalization.preAdmissionIdentifier.typeextensibleIdentifier Type Codes
Encounter.hospitalization.admitSourcerequiredNHS Data Model and Dictionary Source Of Admission
Encounter.hospitalization.reAdmissionexamplev2 Re-Admission Indicator
Encounter.hospitalization.dietPreferenceextensibleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionrequiredInterweave Discharge Destination codes
Encounter.location.statusrequiredEncounterLocationStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorEncounter.hospitalization.extension:admissionMethod, Encounter.hospitalization.extension:dischargeMethodMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CareConnect-Encounter-1

Summary

Mandatory: 9 elements (16 nested mandatory elements)
Must-Support: 26 elements
Fixed Value: 4 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Encounter.meta.tag is sliced based on the value of value:system
  • The element Encounter.identifier is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-Encounter-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*CareConnect-Encounter-1An interaction during which services are provided to the patient
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:encounterTransport 0..0
... extension:outcomeOfAttendance 0..0
... extension:emergencyCareDischargeStatus 0..0
... Slices for identifier 0..*IdentifierIdentifier(s) by which this encounter is known
Slice: Unordered, Open by value:system
.... identifier:localIdentifier S0..1IdentifierIdentifier(s) by which this encounter is known
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-encounter-identifier
..... value S1..1stringThe Local encounter Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... status S1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S1..1CodingClassification of the encounter
Binding: InterweaveEncounterClass (required)
Fixed Value: As shown
.... system1..1uriIdentity of the terminology system
Fixed Value: https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-EncounterClass-1
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: GROUPING
.... display1..1stringRepresentation defined by the system
Fixed Value: Grouping of related Encounters
.... system 1..1uriIdentity of the terminology system
.... code 1..1codeSymbol in syntax defined by the system
.... display 1..1stringRepresentation defined by the system
... classHistory 0..0
... type 0..0
... priority 0..0
... subject S1..1Reference(CareConnectPatient1)The patient (NOT group) present at the encounter
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... episodeOfCare 0..0
... incomingReferral 0..0
... participant 0..0
... appointment 0..0
... period S1..1PeriodThe start and end time of the encounter
.... start S1..1dateTimeStarting time with inclusive boundary
.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
... length 0..1DurationDISCOURAGED: This duplicates information that is already available via the Period
... reason 0..0
... diagnosis 0..0
... account 0..0
... hospitalization S0..1BackboneElementDetails about the admission to a healthcare service
.... extension:admissionMethod S0..1Extension-CareConnect-AdmissionMethod-1An extension to the Encounter resource to record how a Patient was admitted to hospital.
.... extension:dischargeMethod S0..1Extension-CareConnect-DischargeMethod-1An extension to the Encounter resource to record the method of discharge from hospital.
.... medicallySafeForDischarge S0..1(Complex)Medically Safe for Discharge
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-MedicallySafeForDischarge
.... origin 0..1Reference(CareConnect-Location-1)The location from which the patient came before admission. Useful to provide if possible, in particular to reference a 'site' if transfered from another institution.
..... reference 1..1stringReference to a resource (could be Contained)
..... identifier 0..1IdentifierIf relevant could include an id
..... display 1..1stringDescription of the referenced resource
.... admitSource S0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: NHS Data Model and Dictionary Source Of Admission (required)
..... coding
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
.... dietPreference 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
.... specialCourtesy 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
.... specialArrangement 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
.... destination S0..1Reference(CareConnect-Location-1)Location to which the patient is discharged. Important to provide if known to support discharge planning, and/or to reference a 'site' if transfered to another institution.
..... reference 1..1stringReference to a resource (could be Contained)
..... identifier 0..1IdentifierIf relevant could include an id
..... display 1..1stringDescription of the referenced resource
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: Interweave Discharge Destination codes (required)
..... coding
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... location 0..0
... serviceProvider 0..1Reference(CareConnect-Organization-1)DISCOURAGED: This is instead covered via the provenance tags
... partOf 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Encounter.classrequiredFixed Value: GROUPING("Grouping of related Encounters")
Encounter.hospitalization.admitSourcerequiredNHS Data Model and Dictionary Source Of Admission
Encounter.hospitalization.dischargeDispositionrequiredInterweave Discharge Destination codes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*CareConnect-Encounter-1An interaction during which services are provided to the patient
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
.... identifier:localIdentifier SΣ0..1IdentifierIdentifier(s) by which this encounter is known
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-encounter-identifier
..... value SΣ1..1stringThe Local encounter Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter

... class SΣ1..1CodingClassification of the encounter
Binding: InterweaveEncounterClass (required)
Fixed Value: As shown
.... id0..0stringxml:id (or equivalent in JSON)
.... extension0..0ExtensionAdditional Content defined by implementations
.... system1..1uriIdentity of the terminology system
Fixed Value: https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-EncounterClass-1
.... version0..0stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: GROUPING
.... display1..1stringRepresentation defined by the system
Fixed Value: Grouping of related Encounters
.... userSelected0..0booleanIf this coding was chosen directly by the user
.... system Σ1..1uriIdentity of the terminology system
.... code Σ1..1codeSymbol in syntax defined by the system
.... display Σ1..1stringRepresentation defined by the system
... subject SΣ1..1Reference(CareConnectPatient1)The patient (NOT group) present at the encounter
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... period S1..1PeriodThe start and end time of the encounter
.... start SΣC1..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... length 0..1DurationDISCOURAGED: This duplicates information that is already available via the Period
... hospitalization S0..1BackboneElementDetails about the admission to a healthcare service
.... admissionMethod S0..1CodeableConceptAn 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 S0..1CodeableConceptAn 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.


.... medicallySafeForDischarge S0..1(Complex)Medically Safe for Discharge
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-MedicallySafeForDischarge
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... origin 0..1Reference(CareConnect-Location-1)The location from which the patient came before admission. Useful to provide if possible, in particular to reference a 'site' if transfered from another institution.
..... reference ΣC1..1stringReference to a resource (could be Contained)
..... identifier Σ0..1IdentifierIf relevant could include an id
..... display Σ1..1stringDescription of the referenced resource
.... admitSource S0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: NHS Data Model and Dictionary Source Of Admission (required)
.... dietPreference 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: Diet (extensible)
.... specialCourtesy 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: SpecialCourtesy (preferred): Special courtesies


.... specialArrangement 0..*CodeableConceptDISCOURAGED: Relevant for managing the patient's stay, but less so for regional sharing
Binding: SpecialArrangements (preferred): Special arrangements


.... destination S0..1Reference(CareConnect-Location-1)Location to which the patient is discharged. Important to provide if known to support discharge planning, and/or to reference a 'site' if transfered to another institution.
..... reference ΣC1..1stringReference to a resource (could be Contained)
..... identifier Σ0..1IdentifierIf relevant could include an id
..... display Σ1..1stringDescription of the referenced resource
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: Interweave Discharge Destination codes (required)
... serviceProvider 0..1Reference(CareConnect-Organization-1)DISCOURAGED: This is instead covered via the provenance tags

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.meta.securityextensibleAll Security Labels
Encounter.meta.tagexampleCommon Tags
Encounter.meta.tag:SourceexampleCommon Tags
Encounter.meta.tag:ProvenanceexampleCommon Tags
Encounter.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.identifier.userequiredIdentifierUse
Encounter.identifier:localIdentifier.userequiredIdentifierUse
Encounter.statusrequiredEncounterStatus
Encounter.classrequiredFixed Value: GROUPING("Grouping of related Encounters")
Encounter.classHistory.classextensibleActEncounterCode
Encounter.type.coding:snomedCTextensibleCare Connect Encounter Type
Encounter.hospitalization.admitSourcerequiredNHS Data Model and Dictionary Source Of Admission
Encounter.hospitalization.dietPreferenceextensibleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionrequiredInterweave Discharge Destination codes

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEncounterIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorEncounter.hospitalization.extension:admissionMethod, Encounter.hospitalization.extension:dischargeMethodMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*CareConnect-Encounter-1An interaction during which services are provided to the patient
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: