Guide d'implémentation Fr Core
2.1.0 - trial-use
Guide d'implémentation Fr Core, published by Interop'Santé. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Interop-Sante/hl7.fhir.fr.core/ and changes regularly. See the Directory of published versions
Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-encounter | Version: 2.1.0 | |||
Active as of 2024-10-29 | Computable Name: FRCoreEncounterProfile |
This profil constrains the Encounter resource to represent either the patient visit or admission or the various movements that compose the patient stay.
Ce profil de la ressource Encounter sert à la fois à définir la venue dans l’établissement et à représenter les mouvements du patient qui découpent cette venue.
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 | |
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-encounter | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
estimatedDischargeDate | 0..1 | date | Estimated discharge date | Date de sortie estimée URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-estimated-discharge-date | |
identifier | 1..* | Identifier | Identifier(s) by which this encounter is known | identifiant de la rencontre | |
type | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | |
system | 1..1 | uri | The namespace for the identifier value Example OID de l'ANS de gestion des organisations (1.2.250.1.71.4.2.2) suivi du FINESS suivi de la branche z qui gère les id de venue/mouvements si l'établissement n'a pas d'OID (sinon utilisation de l'OID de l'établissement): 1.2.250.1.71.4.2.2.1330780321 Example autre solution, utilisation d'une URL: http://hopitalTest.fr/fhir/namingsystem/encounters | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | |
class | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
type | 0..1 | CodeableConcept | Specific type of encounter Binding: FR Core ValueSet Encounter type (example) | |
subject | 0..1 | Reference(FR Core Patient Profile) | The patient or group present at the encounter | |
participant | 0..* | BackboneElement | List of participants involved in the encounter | Liste des personnes impliquées dans la rencontre | |
individual | 0..1 | Reference(RelatedPerson | FR Core Practitioner Profile | PractitionerRole) | Persons involved in the encounter other than the patient | |
appointment | 0..* | Reference(FR Core Appointment Profile) | The appointment that scheduled this encounter | |
period | 1..1 | Period | The start and end time of the encounter | |
account | 0..1 | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |
hospitalization | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | Identifiant de pré-admission | |
type | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: 1.2.250.1.71.4.2.2+.n°FINESS | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | |
origin | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | The location/organization from which the patient came before admission | |
reAdmission | 0..1 | CodeableConcept | the resaon of re-admission of this hospitalization encounter | Raison de la ré-admission du patient. | |
destination | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | Location/organization to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: FR Core ValueSet Encounter discharge disposition (example) | |
location | ||||
location | 1..1 | Reference(FR Core Location Profile) | Location the encounter takes place | |
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: FR Core ValueSet Location physical type (example) | |
serviceProvider | 0..1 | Reference(FR Core Organization Profile) | The organization (facility) responsible for this encounter | |
partOf | 0..1 | Reference(FR Core Encounter Profile) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | |
Encounter.type | example | FRCoreValueSetEncounterTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-type from this IG | |
Encounter.hospitalization.preAdmissionIdentifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | |
Encounter.hospitalization.dischargeDisposition | example | FRCoreValueSetEncounterDischargeDispositionhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-discharge-disposition from this IG | |
Encounter.location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
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 | |
estimatedDischargeDate | 0..1 | date | Estimated discharge date | Date de sortie estimée URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-estimated-discharge-date | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Identifier(s) by which this encounter is known | identifiant de la rencontre |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example OID de l'ANS de gestion des organisations (1.2.250.1.71.4.2.2) suivi du FINESS suivi de la branche z qui gère les id de venue/mouvements si l'établissement n'a pas d'OID (sinon utilisation de l'OID de l'établissement): 1.2.250.1.71.4.2.2.1330780321 Example autre solution, utilisation d'une URL: http://hopitalTest.fr/fhir/namingsystem/encounters |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | Σ | 0..1 | Reference(FR Core Organization Profile) | 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. |
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
type | Σ | 0..1 | CodeableConcept | Specific type of encounter Binding: FR Core ValueSet Encounter type (example) |
subject | Σ | 0..1 | Reference(FR Core Patient Profile) | The patient or group present at the encounter |
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter | Liste des personnes impliquées dans la rencontre |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
individual | Σ | 0..1 | Reference(RelatedPerson | FR Core Practitioner Profile | PractitionerRole) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..* | Reference(FR Core Appointment Profile) | The appointment that scheduled this encounter |
period | 1..1 | Period | The start and end time of the encounter | |
account | 0..1 | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |
serviceProvider | 0..1 | Reference(FR Core Organization Profile) | The organization (facility) responsible for this encounter | |
partOf | 0..1 | Reference(FR Core Encounter Profile) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.identifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | example | FRCoreValueSetEncounterTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-encounter | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
estimatedDischargeDate | 0..1 | date | Estimated discharge date | Date de sortie estimée URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-estimated-discharge-date | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Identifier(s) by which this encounter is known | identifiant de la rencontre | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example OID de l'ANS de gestion des organisations (1.2.250.1.71.4.2.2) suivi du FINESS suivi de la branche z qui gère les id de venue/mouvements si l'établissement n'a pas d'OID (sinon utilisation de l'OID de l'établissement): 1.2.250.1.71.4.2.2.1330780321 Example autre solution, utilisation d'une URL: http://hopitalTest.fr/fhir/namingsystem/encounters | ||||
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(FR Core Organization Profile) | 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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | Σ | 0..1 | CodeableConcept | Specific type of encounter Binding: FR Core ValueSet Encounter type (example) | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | Σ | 0..1 | Reference(FR Core Patient Profile) | The patient or group present at the encounter | ||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter | Liste des personnes impliquées dans la rencontre | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
individual | Σ | 0..1 | Reference(RelatedPerson | FR Core Practitioner Profile | PractitionerRole) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..* | Reference(FR Core Appointment Profile) | The appointment that scheduled this encounter | ||||
period | 1..1 | Period | The start and end time of the encounter | |||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | 0..1 | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | Identifiant de pré-admission | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: 1.2.250.1.71.4.2.2+.n°FINESS | ||||
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(FR Core Organization Profile) | Organization that issued id (may be just text) | ||||
origin | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | The location/organization from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
reAdmission | 0..1 | CodeableConcept | the resaon of re-admission of this hospitalization encounter | Raison de la ré-admission du patient. Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: FR Core ValueSet Encounter discharge disposition (example) | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
location | 1..1 | Reference(FR Core Location Profile) | Location the encounter takes place | |||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: FR Core ValueSet Location physical type (example) | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | 0..1 | Reference(FR Core Organization Profile) | The organization (facility) responsible for this encounter | |||||
partOf | 0..1 | Reference(FR Core Encounter Profile) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | example | FRCoreValueSetEncounterTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-type from this IG | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.preAdmissionIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.hospitalization.preAdmissionIdentifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | FRCoreValueSetEncounterDischargeDispositionhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-discharge-disposition from this IG | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 1 element
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 | |
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-encounter | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
estimatedDischargeDate | 0..1 | date | Estimated discharge date | Date de sortie estimée URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-estimated-discharge-date | |
identifier | 1..* | Identifier | Identifier(s) by which this encounter is known | identifiant de la rencontre | |
type | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | |
system | 1..1 | uri | The namespace for the identifier value Example OID de l'ANS de gestion des organisations (1.2.250.1.71.4.2.2) suivi du FINESS suivi de la branche z qui gère les id de venue/mouvements si l'établissement n'a pas d'OID (sinon utilisation de l'OID de l'établissement): 1.2.250.1.71.4.2.2.1330780321 Example autre solution, utilisation d'une URL: http://hopitalTest.fr/fhir/namingsystem/encounters | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | |
class | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
type | 0..1 | CodeableConcept | Specific type of encounter Binding: FR Core ValueSet Encounter type (example) | |
subject | 0..1 | Reference(FR Core Patient Profile) | The patient or group present at the encounter | |
participant | 0..* | BackboneElement | List of participants involved in the encounter | Liste des personnes impliquées dans la rencontre | |
individual | 0..1 | Reference(RelatedPerson | FR Core Practitioner Profile | PractitionerRole) | Persons involved in the encounter other than the patient | |
appointment | 0..* | Reference(FR Core Appointment Profile) | The appointment that scheduled this encounter | |
period | 1..1 | Period | The start and end time of the encounter | |
account | 0..1 | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |
hospitalization | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | Identifiant de pré-admission | |
type | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: 1.2.250.1.71.4.2.2+.n°FINESS | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | |
origin | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | The location/organization from which the patient came before admission | |
reAdmission | 0..1 | CodeableConcept | the resaon of re-admission of this hospitalization encounter | Raison de la ré-admission du patient. | |
destination | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | Location/organization to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: FR Core ValueSet Encounter discharge disposition (example) | |
location | ||||
location | 1..1 | Reference(FR Core Location Profile) | Location the encounter takes place | |
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: FR Core ValueSet Location physical type (example) | |
serviceProvider | 0..1 | Reference(FR Core Organization Profile) | The organization (facility) responsible for this encounter | |
partOf | 0..1 | Reference(FR Core Encounter Profile) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | |
Encounter.type | example | FRCoreValueSetEncounterTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-type from this IG | |
Encounter.hospitalization.preAdmissionIdentifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | |
Encounter.hospitalization.dischargeDisposition | example | FRCoreValueSetEncounterDischargeDispositionhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-discharge-disposition from this IG | |
Encounter.location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
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 | |
estimatedDischargeDate | 0..1 | date | Estimated discharge date | Date de sortie estimée URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-estimated-discharge-date | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Identifier(s) by which this encounter is known | identifiant de la rencontre |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example OID de l'ANS de gestion des organisations (1.2.250.1.71.4.2.2) suivi du FINESS suivi de la branche z qui gère les id de venue/mouvements si l'établissement n'a pas d'OID (sinon utilisation de l'OID de l'établissement): 1.2.250.1.71.4.2.2.1330780321 Example autre solution, utilisation d'une URL: http://hopitalTest.fr/fhir/namingsystem/encounters |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | Σ | 0..1 | Reference(FR Core Organization Profile) | 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. |
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
type | Σ | 0..1 | CodeableConcept | Specific type of encounter Binding: FR Core ValueSet Encounter type (example) |
subject | Σ | 0..1 | Reference(FR Core Patient Profile) | The patient or group present at the encounter |
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter | Liste des personnes impliquées dans la rencontre |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
individual | Σ | 0..1 | Reference(RelatedPerson | FR Core Practitioner Profile | PractitionerRole) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..* | Reference(FR Core Appointment Profile) | The appointment that scheduled this encounter |
period | 1..1 | Period | The start and end time of the encounter | |
account | 0..1 | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |
serviceProvider | 0..1 | Reference(FR Core Organization Profile) | The organization (facility) responsible for this encounter | |
partOf | 0..1 | Reference(FR Core Encounter Profile) | Another Encounter this encounter is part of | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.identifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | example | FRCoreValueSetEncounterTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-encounter | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
estimatedDischargeDate | 0..1 | date | Estimated discharge date | Date de sortie estimée URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-estimated-discharge-date | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Identifier(s) by which this encounter is known | identifiant de la rencontre | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example OID de l'ANS de gestion des organisations (1.2.250.1.71.4.2.2) suivi du FINESS suivi de la branche z qui gère les id de venue/mouvements si l'établissement n'a pas d'OID (sinon utilisation de l'OID de l'établissement): 1.2.250.1.71.4.2.2.1330780321 Example autre solution, utilisation d'une URL: http://hopitalTest.fr/fhir/namingsystem/encounters | ||||
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(FR Core Organization Profile) | 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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | Σ | 0..1 | CodeableConcept | Specific type of encounter Binding: FR Core ValueSet Encounter type (example) | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | Σ | 0..1 | Reference(FR Core Patient Profile) | The patient or group present at the encounter | ||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter | Liste des personnes impliquées dans la rencontre | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
individual | Σ | 0..1 | Reference(RelatedPerson | FR Core Practitioner Profile | PractitionerRole) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..* | Reference(FR Core Appointment Profile) | The appointment that scheduled this encounter | ||||
period | 1..1 | Period | The start and end time of the encounter | |||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | 0..1 | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | Identifiant de pré-admission | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Encounter identifier type (extensible) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: 1.2.250.1.71.4.2.2+.n°FINESS | ||||
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(FR Core Organization Profile) | Organization that issued id (may be just text) | ||||
origin | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | The location/organization from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
reAdmission | 0..1 | CodeableConcept | the resaon of re-admission of this hospitalization encounter | Raison de la ré-admission du patient. Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | 0..1 | Reference(FR Core Location Profile | FR Core Organization Profile) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: FR Core ValueSet Encounter discharge disposition (example) | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
location | 1..1 | Reference(FR Core Location Profile) | Location the encounter takes place | |||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: FR Core ValueSet Location physical type (example) | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | 0..1 | Reference(FR Core Organization Profile) | The organization (facility) responsible for this encounter | |||||
partOf | 0..1 | Reference(FR Core Encounter Profile) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | example | FRCoreValueSetEncounterTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-type from this IG | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.preAdmissionIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.hospitalization.preAdmissionIdentifier.type | extensible | FRCoreValueSetEncounterIdentifierType (a valid code from FR Core CodeSystem Identifier Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-identifier-type from this IG | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | FRCoreValueSetEncounterDischargeDispositionhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-encounter-discharge-disposition from this IG | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 1 element
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