PLUGIN
0.0.2-ci - ci-build NL

PLUGIN - Local Development build (v0.0.2-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Encounter

Official URL: https://plugin.healthcare/fhir/StructureDefinition/plugin-encounter Version: 0.0.2-ci
Draft as of 2025-10-08 Computable Name: PluginEncounter

Copyright/Legal: Used by permission of the PLUGIN team, all rights reserved Creative Commons License

Contactmoment tussen patiënt en zorgverlener. Maturity Level: 0 Draft. Open issues see Github.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* NlcoreEncounter Encounter
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Identifier(s) by which this encounter is known
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (required)
... serviceType SΣ 1..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 (required)
... subject SΣ 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
... Slices for participant Σ 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by profile:individual.resolve()
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter.
..... individual SΣ 0..1 Reference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) ContactWith
... period 0..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime StartDateTime
.... end SΣC 0..1 dateTime EndDateTime
... Slices for reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Slice: Unordered, Open by exists:coding
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... reasonCode:deviatingResult Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
... Slices for reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
.... reasonReference:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
.... reasonReference:problem Σ 0..* Reference(nl core Problem) Problem
.... reasonReference:procedure Σ 0..* Reference(nl core Procedure event) Procedure
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... admitSource S 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (extensible): From where the patient was admitted.
.... dischargeDisposition S 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (extensible): Discharge Disposition.
... location 0..1 BackboneElement List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location | nl core HealthcareProvider) Location
... partOf S 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required ActEncounterCode 📦3.0.0 THO v6.5
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base required ActPriority 📦3.0.0 THO v6.5
Encounter.participant:healthProfessional.​type Base extensible ZorgverlenerRolCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.reasonCode:deviatingResult Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible HerkomstCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.hospitalization.​dischargeDisposition Base extensible BestemmingCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from NlcoreEncounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* NlcoreEncounter Encounter
... identifier S 1..* Identifier Identifier(s) by which this encounter is known
... status S 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class 1..1 Coding ContactType
Binding: ActEncounterCode (required)
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (required)
... subject S 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
... Slices for participant Content/Rules for all slices
.... participant:healthProfessional S 0..* BackboneElement List of participants involved in the encounter
..... type S 0..1 CodeableConcept HealthProfessionalRole
..... individual S 0..1 Reference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) ContactWith
... period
.... start S 0..1 dateTime StartDateTime
.... end S 0..1 dateTime EndDateTime
... hospitalization
.... admitSource S 0..1 CodeableConcept Origin
.... dischargeDisposition S 0..1 CodeableConcept Destination
... partOf S 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base required ActEncounterCode 📦3.0.0 THO v6.5
Encounter.priority Base required ActPriority 📦3.0.0 THO v6.5
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* NlcoreEncounter Encounter
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (required)
... 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..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType SΣ 1..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 (required)
... subject SΣ 1..1 Reference(Patient | nl core Patient) 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
... Slices for participant Σ 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by profile:individual.resolve()
.... participant:All Slices Content/Rules for all slices
..... 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(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter.
..... period 0..1 Period Period of time during the encounter that the participant participated
..... individual SΣ 0..1 Reference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) ContactWith
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time 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
.... start SΣC 0..1 dateTime StartDateTime
.... end SΣC 0..1 dateTime EndDateTime
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... Slices for reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Slice: Unordered, Open by exists:coding
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... reasonCode:deviatingResult Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string CommentContactReason
..... text Σ 0..1 string DeviatingResult
... Slices for reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
.... reasonReference:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string CommentContactReason
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... reasonReference:problem Σ 0..* Reference(nl core Problem) Problem
.... reasonReference:procedure Σ 0..* Reference(nl core Procedure event) Procedure
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource S 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (extensible): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (extensible): Discharge Disposition.
... location 0..1 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(Location | nl core HealthcareProvider) Location
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf S 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required ActEncounterCode 📦3.0.0 THO v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base example Encounter type 📦4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base required ActPriority 📦3.0.0 THO v6.5
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:healthProfessional.​type Base extensible ZorgverlenerRolCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.reasonCode:deviatingResult Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.reasonReference.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible HerkomstCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v6.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base extensible BestemmingCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* NlcoreEncounter Encounter
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Identifier(s) by which this encounter is known
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (required)
... serviceType SΣ 1..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 (required)
... subject SΣ 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
... Slices for participant Σ 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by profile:individual.resolve()
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter.
..... individual SΣ 0..1 Reference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) ContactWith
... period 0..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime StartDateTime
.... end SΣC 0..1 dateTime EndDateTime
... Slices for reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Slice: Unordered, Open by exists:coding
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... reasonCode:deviatingResult Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
... Slices for reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
.... reasonReference:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
.... reasonReference:problem Σ 0..* Reference(nl core Problem) Problem
.... reasonReference:procedure Σ 0..* Reference(nl core Procedure event) Procedure
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... admitSource S 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (extensible): From where the patient was admitted.
.... dischargeDisposition S 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (extensible): Discharge Disposition.
... location 0..1 BackboneElement List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location | nl core HealthcareProvider) Location
... partOf S 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required ActEncounterCode 📦3.0.0 THO v6.5
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base required ActPriority 📦3.0.0 THO v6.5
Encounter.participant:healthProfessional.​type Base extensible ZorgverlenerRolCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.reasonCode:deviatingResult Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible HerkomstCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.hospitalization.​dischargeDisposition Base extensible BestemmingCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from NlcoreEncounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* NlcoreEncounter Encounter
... identifier S 1..* Identifier Identifier(s) by which this encounter is known
... status S 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class 1..1 Coding ContactType
Binding: ActEncounterCode (required)
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (required)
... subject S 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
... Slices for participant Content/Rules for all slices
.... participant:healthProfessional S 0..* BackboneElement List of participants involved in the encounter
..... type S 0..1 CodeableConcept HealthProfessionalRole
..... individual S 0..1 Reference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) ContactWith
... period
.... start S 0..1 dateTime StartDateTime
.... end S 0..1 dateTime EndDateTime
... hospitalization
.... admitSource S 0..1 CodeableConcept Origin
.... dischargeDisposition S 0..1 CodeableConcept Destination
... partOf S 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base required ActEncounterCode 📦3.0.0 THO v6.5
Encounter.priority Base required ActPriority 📦3.0.0 THO v6.5

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* NlcoreEncounter Encounter
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (required)
... 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..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType SΣ 1..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 (required)
... subject SΣ 1..1 Reference(Patient | nl core Patient) 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
... Slices for participant Σ 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by profile:individual.resolve()
.... participant:All Slices Content/Rules for all slices
..... 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(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter.
..... period 0..1 Period Period of time during the encounter that the participant participated
..... individual SΣ 0..1 Reference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) ContactWith
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time 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
.... start SΣC 0..1 dateTime StartDateTime
.... end SΣC 0..1 dateTime EndDateTime
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... Slices for reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Slice: Unordered, Open by exists:coding
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... reasonCode:deviatingResult Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string CommentContactReason
..... text Σ 0..1 string DeviatingResult
... Slices for reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
.... reasonReference:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:commentContactReason N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string CommentContactReason
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... reasonReference:problem Σ 0..* Reference(nl core Problem) Problem
.... reasonReference:procedure Σ 0..* Reference(nl core Procedure event) Procedure
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource S 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (extensible): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (extensible): Discharge Disposition.
... location 0..1 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(Location | nl core HealthcareProvider) Location
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf S 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required ActEncounterCode 📦3.0.0 THO v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base example Encounter type 📦4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base required ActPriority 📦3.0.0 THO v6.5
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:healthProfessional.​type Base extensible ZorgverlenerRolCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.reasonCode:deviatingResult Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.reasonReference.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible HerkomstCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v6.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base extensible BestemmingCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron