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-05-30 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

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
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 1..* Identifier Identifier(s) by which this encounter is known
ele-1: All FHIR elements must have a @value or children
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (required)
ele-1: All FHIR elements must have a @value or children
... serviceType SΣ 1..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.


ele-1: All FHIR elements must have a @value or children
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (required)
ele-1: All FHIR elements must have a @value or children
... subject SΣC 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... Slices for participant ΣN 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by profile:individual.resolve()
ele-1: All FHIR elements must have a @value or children
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!ΣN 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children
..... individual SΣC 0..1 PatternNlCoreHealthProfessionalReference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) A reference from one resource to another
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... period C 0..1 Period The start and end time of the encounter
ele-1: All FHIR elements must have a @value or children
per-1: If present, start SHALL have a lower value than end
.... start SΣC 0..1 dateTime StartDateTime
ele-1: All FHIR elements must have a @value or children
.... end SΣC 0..1 dateTime EndDateTime
ele-1: All FHIR elements must have a @value or children
... Slices for reasonCode ΣN 0..* CodeableConcept Coded reason the encounter takes place
Slice: Unordered, Open by exists:coding
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


ele-1: All FHIR elements must have a @value or children
.... reasonCode:deviatingResult ΣN 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


ele-1: All FHIR elements must have a @value or children
..... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
... Slices for reasonReference ΣCN 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... reasonReference:problem ΣCN 0..* Reference(nl core Problem) Problem
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... reasonReference:procedure ΣCN 0..* Reference(nl core Procedure event) Procedure
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... admitSource S 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (extensible): From where the patient was admitted.


ele-1: All FHIR elements must have a @value or children
.... dischargeDisposition S 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (extensible): Discharge Disposition.


ele-1: All FHIR elements must have a @value or children
... location 0..1 BackboneElement List of locations where the patient has been
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... partOf SC 0..1 Reference(Encounter) Another Encounter this encounter is part of
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityrequiredActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant:healthProfessional.typeextensibleZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.hospitalization.admitSourceextensibleHerkomstCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000
Encounter.hospitalization.dischargeDispositionextensibleBestemmingCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorEncounter.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorEncounter.subject, Encounter.participant:healthProfessional.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.location, Encounter.partOfSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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 PatternNlCoreHealthProfessionalReference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) A reference from one resource to another
... 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)

PathConformanceValueSetURI
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.priorityrequiredActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
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
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 1..1 Period The time that the episode was in the specified status
per-1: If present, start SHALL have a lower value than end
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 1..1 Period The time that the episode was in the specified class
per-1: If present, start SHALL have a lower value than end
... 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ΣC 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
ref-1: SHALL have a contained resource if a local reference is provided
... episodeOfCare ΣC 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
ref-1: SHALL have a contained resource if a local reference is provided
... basedOn C 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
ref-1: SHALL have a contained resource if a local reference is provided
... Slices for participant ΣN 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!ΣN 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type ΣN 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


..... period CN 0..1 Period Period of time during the encounter that the participant participated
per-1: If present, start SHALL have a lower value than end
..... individual ΣCN 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
ref-1: SHALL have a contained resource if a local reference is provided
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 C 0..1 Period Period of time during the encounter that the participant participated
per-1: If present, start SHALL have a lower value than end
..... individual SΣC 0..1 PatternNlCoreHealthProfessionalReference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... appointment ΣC 0..* Reference(Appointment) The appointment that scheduled this encounter
ref-1: SHALL have a contained resource if a local reference is provided
... period C 0..1 Period The start and end time of the encounter
per-1: If present, start SHALL have a lower value than end
.... id 0..1 string Unique id for inter-element referencing
.... extension N 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 C 0..1 Duration Quantity of time the encounter lasted (less time absent)
qty-3: If a code for the unit is present, the system SHALL also be present
drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
... Slices for reasonCode ΣN 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 ΣN 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 N 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 N 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] N 0..1 string CommentContactReason
..... text Σ 0..1 string DeviatingResult
... Slices for reasonReference ΣCN 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
ref-1: SHALL have a contained resource if a local reference is provided
.... reasonReference:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 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 N 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] N 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 ΣN 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... reasonReference:problem ΣCN 0..* Reference(nl core Problem) Problem
ref-1: SHALL have a contained resource if a local reference is provided
.... reasonReference:procedure ΣCN 0..* Reference(nl core Procedure event) Procedure
ref-1: SHALL have a contained resource if a local reference is provided
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition ΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 C 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
ref-1: SHALL have a contained resource if a local reference is provided
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin C 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 C 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 C 0..1 Period Time period during which the patient was present at the location
per-1: If present, start SHALL have a lower value than end
... serviceProvider C 0..1 Reference(Organization) The organization (facility) responsible for this encounter
ref-1: SHALL have a contained resource if a local reference is provided
... partOf SC 0..1 Reference(Encounter) Another Encounter this encounter is part of
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityrequiredActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.participant:healthProfessional.typeextensibleZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.reasonReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.admitSourceextensibleHerkomstCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleBestemmingCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
drt-1errorEncounter.lengthThere SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
: code.exists() implies ((system = %ucum) and value.exists())
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorEncounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.participant:healthProfessional.period, Encounter.period, Encounter.location.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3errorEncounter.lengthIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorEncounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant.individual, Encounter.participant:healthProfessional.individual, Encounter.appointment, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis.condition, Encounter.account, Encounter.hospitalization.origin, Encounter.hospitalization.destination, Encounter.location.location, Encounter.serviceProvider, Encounter.partOfSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* NlcoreEncounter Encounter
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 1..* Identifier Identifier(s) by which this encounter is known
ele-1: All FHIR elements must have a @value or children
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (required)
ele-1: All FHIR elements must have a @value or children
... serviceType SΣ 1..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.


ele-1: All FHIR elements must have a @value or children
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (required)
ele-1: All FHIR elements must have a @value or children
... subject SΣC 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... Slices for participant ΣN 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by profile:individual.resolve()
ele-1: All FHIR elements must have a @value or children
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!ΣN 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children
..... individual SΣC 0..1 PatternNlCoreHealthProfessionalReference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) A reference from one resource to another
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... period C 0..1 Period The start and end time of the encounter
ele-1: All FHIR elements must have a @value or children
per-1: If present, start SHALL have a lower value than end
.... start SΣC 0..1 dateTime StartDateTime
ele-1: All FHIR elements must have a @value or children
.... end SΣC 0..1 dateTime EndDateTime
ele-1: All FHIR elements must have a @value or children
... Slices for reasonCode ΣN 0..* CodeableConcept Coded reason the encounter takes place
Slice: Unordered, Open by exists:coding
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


ele-1: All FHIR elements must have a @value or children
.... reasonCode:deviatingResult ΣN 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


ele-1: All FHIR elements must have a @value or children
..... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
... Slices for reasonReference ΣCN 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... reasonReference:problem ΣCN 0..* Reference(nl core Problem) Problem
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... reasonReference:procedure ΣCN 0..* Reference(nl core Procedure event) Procedure
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... admitSource S 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (extensible): From where the patient was admitted.


ele-1: All FHIR elements must have a @value or children
.... dischargeDisposition S 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (extensible): Discharge Disposition.


ele-1: All FHIR elements must have a @value or children
... location 0..1 BackboneElement List of locations where the patient has been
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... partOf SC 0..1 Reference(Encounter) Another Encounter this encounter is part of
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityrequiredActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant:healthProfessional.typeextensibleZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.hospitalization.admitSourceextensibleHerkomstCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000
Encounter.hospitalization.dischargeDispositionextensibleBestemmingCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorEncounter.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorEncounter.subject, Encounter.participant:healthProfessional.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.location, Encounter.partOfSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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 PatternNlCoreHealthProfessionalReference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) A reference from one resource to another
... 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)

PathConformanceValueSetURI
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.priorityrequiredActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority

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
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 1..1 Period The time that the episode was in the specified status
per-1: If present, start SHALL have a lower value than end
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 1..1 Period The time that the episode was in the specified class
per-1: If present, start SHALL have a lower value than end
... 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ΣC 1..1 Reference(Patient | nl core Patient) The patient or group present at the encounter
ref-1: SHALL have a contained resource if a local reference is provided
... episodeOfCare ΣC 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
ref-1: SHALL have a contained resource if a local reference is provided
... basedOn C 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
ref-1: SHALL have a contained resource if a local reference is provided
... Slices for participant ΣN 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!ΣN 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type ΣN 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


..... period CN 0..1 Period Period of time during the encounter that the participant participated
per-1: If present, start SHALL have a lower value than end
..... individual ΣCN 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
ref-1: SHALL have a contained resource if a local reference is provided
.... participant:healthProfessional SΣ 0..* BackboneElement List of participants involved in the encounter
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 C 0..1 Period Period of time during the encounter that the participant participated
per-1: If present, start SHALL have a lower value than end
..... individual SΣC 0..1 PatternNlCoreHealthProfessionalReference(PractitionerRoleWithSpecialty | nl core HealthProfessional PractitionerRole) A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... appointment ΣC 0..* Reference(Appointment) The appointment that scheduled this encounter
ref-1: SHALL have a contained resource if a local reference is provided
... period C 0..1 Period The start and end time of the encounter
per-1: If present, start SHALL have a lower value than end
.... id 0..1 string Unique id for inter-element referencing
.... extension N 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 C 0..1 Duration Quantity of time the encounter lasted (less time absent)
qty-3: If a code for the unit is present, the system SHALL also be present
drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
... Slices for reasonCode ΣN 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 ΣN 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 N 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 N 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] N 0..1 string CommentContactReason
..... text Σ 0..1 string DeviatingResult
... Slices for reasonReference ΣCN 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
ref-1: SHALL have a contained resource if a local reference is provided
.... reasonReference:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 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 N 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] N 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 ΣN 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... reasonReference:problem ΣCN 0..* Reference(nl core Problem) Problem
ref-1: SHALL have a contained resource if a local reference is provided
.... reasonReference:procedure ΣCN 0..* Reference(nl core Procedure event) Procedure
ref-1: SHALL have a contained resource if a local reference is provided
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition ΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 C 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
ref-1: SHALL have a contained resource if a local reference is provided
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin C 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 C 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
ref-1: SHALL have a contained resource if a local reference is provided
.... 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 C 0..1 Period Time period during which the patient was present at the location
per-1: If present, start SHALL have a lower value than end
... serviceProvider C 0..1 Reference(Organization) The organization (facility) responsible for this encounter
ref-1: SHALL have a contained resource if a local reference is provided
... partOf SC 0..1 Reference(Encounter) Another Encounter this encounter is part of
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityrequiredActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.participant:healthProfessional.typeextensibleZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.reasonReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.admitSourceextensibleHerkomstCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleBestemmingCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
drt-1errorEncounter.lengthThere SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
: code.exists() implies ((system = %ucum) and value.exists())
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorEncounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.participant:healthProfessional.period, Encounter.period, Encounter.location.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3errorEncounter.lengthIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorEncounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant.individual, Encounter.participant:healthProfessional.individual, Encounter.appointment, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis.condition, Encounter.account, Encounter.hospitalization.origin, Encounter.hospitalization.destination, Encounter.location.location, Encounter.serviceProvider, Encounter.partOfSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

 

Other representations of profile: CSV, Excel, Schematron