Advance Care Planning (PZP)
1.0.0-rc1 - trial-use

This page is part of the Advance Care Planning (PZP) (v1.0.0-rc1: Release 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: Encounter

Official URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Encounter Version: 1.0.0-rc1
Draft as of 2025-10-30 Computable Name: ACPEncounter

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

Any interaction, regardless of the situation, between a patient and the healthcare provider, in which the healthcare provider has primary responsibility for diagnosing, evaluating and treating the patient’s condition and informing the patient. These can be visits, appointments or non face-to-face interactions. Based on nl-core-Encounter and HCIM Encounter.

Usages:

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
Slice: Unordered, Open by value:url
Constraints: ext-1
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... subject OΣC 0..1 Reference(Patient(1.0.0-rc1)) The patient or group present at the encounter
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... 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
Constraints: ext-1
.... participant:healthProfessional OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter.
..... individual ΣC 0..1 Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) ContactWith
Constraints: ref-1
.... participant:contactPerson OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... individual ΣC 0..1 Reference(ContactPerson(1.0.0-rc1)) Persons involved in the encounter other than the patient
Constraints: ref-1
... 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 O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string CommentContactReason
... Slices for reasonReference ΣC 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
Constraints: ref-1
.... reasonReference:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... 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
.... reasonReference:problem ΣC 0..* Reference(nl core Problem) Problem
Constraints: ref-1
.... reasonReference:procedure OΣC 0..* Reference(nl core Procedure event) Procedure
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... location 0..1 BackboneElement List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
Constraints: ref-1

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.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0
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|2020-09-01T00:00:00
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
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()
ele-1errorEncounter.implicitRules, Encounter.modifierExtension, Encounter.status, Encounter.class, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.individual, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonReference, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location, Encounter.location.modifierExtension, Encounter.location.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.modifierExtension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason, Encounter.location.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorEncounter.subject, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.locationSHALL 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
... class 1..1 Coding ContactType
... subject O 0..1 Reference(Patient(1.0.0-rc1)) The patient or group present at the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... participant 0..* BackboneElement List of participants involved in the encounter
.... participant:healthProfessional O 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... individual 0..1 Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) ContactWith
.... participant:contactPerson O 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... individual 0..1 Reference(ContactPerson(1.0.0-rc1)) Persons involved in the encounter other than the patient
... period
.... start O 0..1 dateTime StartDateTime
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for reasonCode Content/Rules for all slices
.... reasonCode:deviatingResult 0..* CodeableConcept Coded reason the encounter takes place
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason O 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 0..1 string CommentContactReason
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
.... Slices for extension Content/Rules for all slices
..... extension:commentContactReason O 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... value[x] 0..1 string CommentContactReason
... Slices for reasonReference Content/Rules for all slices
.... reasonReference:procedure O 0..* Reference(nl core Procedure event) Procedure
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter

doco Documentation for this format
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
Slice: Unordered, Open by value:url
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: per-1
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (3.0.0) (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode.
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
.... period C 1..1 Period The time that the episode was in the specified class
Constraints: per-1
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... subject OΣC 0..1 Reference(Patient(1.0.0-rc1)) The patient or group present at the encounter
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... episodeOfCare ΣC 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Constraints: ref-1
... basedOn C 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Constraints: ref-1
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period C 0..1 Period Period of time during the encounter that the participant participated
Constraints: per-1
..... individual ΣC 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Constraints: ref-1
.... participant:healthProfessional OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter.
..... period C 0..1 Period Period of time during the encounter that the participant participated
Constraints: per-1
..... individual ΣC 0..1 Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) ContactWith
Constraints: ref-1
.... participant:contactPerson OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period C 0..1 Period Period of time during the encounter that the participant participated
Constraints: per-1
..... individual ΣC 0..1 Reference(ContactPerson(1.0.0-rc1)) Persons involved in the encounter other than the patient
Constraints: ref-1
... appointment ΣC 0..* Reference(Appointment) The appointment that scheduled this encounter
Constraints: ref-1
... period C 0..1 Period The start and end time of the encounter
Constraints: per-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... start OΣC 0..1 dateTime StartDateTime
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... end ΣC 0..1 dateTime EndDateTime
... length C 0..1 Duration Quantity of time the encounter lasted (less time absent)
Constraints: qty-3, drt-1
... 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
Constraints: ext-1
...... extension:commentContactReason O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ΣC 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
Constraints: ref-1
.... 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
Constraints: ext-1
...... extension:commentContactReason O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ΣC 0..* Reference(nl core Problem) Problem
Constraints: ref-1
.... reasonReference:procedure OΣC 0..* Reference(nl core Procedure event) Procedure
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition ΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ref-1
.... 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
Constraints: ref-1
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin C 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Constraints: ref-1
.... admitSource 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (2020-09-01T00:00:00) (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: Hl7VSReAdmissionIndicator (2.0.0) (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
Constraints: ref-1
.... dischargeDisposition 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (2020-09-01T00:00:00) (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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
Constraints: ref-1
.... 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
Constraints: per-1
... serviceProvider C 0..1 Reference(Organization) The organization (facility) responsible for this encounter
Constraints: ref-1
... partOf C 0..1 Reference(Encounter) Another Encounter this encounter is part of
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
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.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type|4.0.1
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type|4.0.1
From the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1
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|2020-09-01T00:00:00
Encounter.participant:contactPerson.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
From the FHIR Standard
Encounter.reasonReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role|4.0.1
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|2020-09-01T00:00:00
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092|2.0.0
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet|4.0.1
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy|4.0.1
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements|4.0.1
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|2020-09-01T00:00:00
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|4.0.1
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-1errorEncounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.period, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.type, Encounter.participant:contactPerson.period, Encounter.participant:contactPerson.individual, Encounter.appointment, Encounter.period, Encounter.period.extension, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonCode:deviatingResult.text, Encounter.reasonReference, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference.type, Encounter.reasonReference.identifier, Encounter.reasonReference.display, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.extension, Encounter.modifierExtension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.period.extension, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtensionMust 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.participant:contactPerson.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.participant:contactPerson.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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Constraints: ext-1
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... subject OΣC 0..1 Reference(Patient(1.0.0-rc1)) The patient or group present at the encounter
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... 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
Constraints: ext-1
.... participant:healthProfessional OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter.
..... individual ΣC 0..1 Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) ContactWith
Constraints: ref-1
.... participant:contactPerson OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... individual ΣC 0..1 Reference(ContactPerson(1.0.0-rc1)) Persons involved in the encounter other than the patient
Constraints: ref-1
... 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 O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string CommentContactReason
... Slices for reasonReference ΣC 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
Constraints: ref-1
.... reasonReference:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... 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
.... reasonReference:problem ΣC 0..* Reference(nl core Problem) Problem
Constraints: ref-1
.... reasonReference:procedure OΣC 0..* Reference(nl core Procedure event) Procedure
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... location 0..1 BackboneElement List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
Constraints: ref-1

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.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0
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|2020-09-01T00:00:00
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
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()
ele-1errorEncounter.implicitRules, Encounter.modifierExtension, Encounter.status, Encounter.class, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.individual, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonReference, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location, Encounter.location.modifierExtension, Encounter.location.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.modifierExtension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason, Encounter.location.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorEncounter.subject, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.locationSHALL 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
... class 1..1 Coding ContactType
... subject O 0..1 Reference(Patient(1.0.0-rc1)) The patient or group present at the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... participant 0..* BackboneElement List of participants involved in the encounter
.... participant:healthProfessional O 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... individual 0..1 Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) ContactWith
.... participant:contactPerson O 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... individual 0..1 Reference(ContactPerson(1.0.0-rc1)) Persons involved in the encounter other than the patient
... period
.... start O 0..1 dateTime StartDateTime
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for reasonCode Content/Rules for all slices
.... reasonCode:deviatingResult 0..* CodeableConcept Coded reason the encounter takes place
..... Slices for extension Content/Rules for all slices
...... extension:commentContactReason O 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 0..1 string CommentContactReason
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
.... Slices for extension Content/Rules for all slices
..... extension:commentContactReason O 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... value[x] 0..1 string CommentContactReason
... Slices for reasonReference Content/Rules for all slices
.... reasonReference:procedure O 0..* Reference(nl core Procedure event) Procedure
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter

doco Documentation for this format

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
Slice: Unordered, Open by value:url
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: per-1
... class Σ 1..1 Coding ContactType
Binding: ActEncounterCode (3.0.0) (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode.
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
.... period C 1..1 Period The time that the episode was in the specified class
Constraints: per-1
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... subject OΣC 0..1 Reference(Patient(1.0.0-rc1)) The patient or group present at the encounter
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... episodeOfCare ΣC 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Constraints: ref-1
... basedOn C 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Constraints: ref-1
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period C 0..1 Period Period of time during the encounter that the participant participated
Constraints: per-1
..... individual ΣC 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Constraints: ref-1
.... participant:healthProfessional OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..1 CodeableConcept HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter.
..... period C 0..1 Period Period of time during the encounter that the participant participated
Constraints: per-1
..... individual ΣC 0..1 Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) ContactWith
Constraints: ref-1
.... participant:contactPerson OΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period C 0..1 Period Period of time during the encounter that the participant participated
Constraints: per-1
..... individual ΣC 0..1 Reference(ContactPerson(1.0.0-rc1)) Persons involved in the encounter other than the patient
Constraints: ref-1
... appointment ΣC 0..* Reference(Appointment) The appointment that scheduled this encounter
Constraints: ref-1
... period C 0..1 Period The start and end time of the encounter
Constraints: per-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... start OΣC 0..1 dateTime StartDateTime
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... end ΣC 0..1 dateTime EndDateTime
... length C 0..1 Duration Quantity of time the encounter lasted (less time absent)
Constraints: qty-3, drt-1
... 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
Constraints: ext-1
...... extension:commentContactReason O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ΣC 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Slice: Unordered, Open by profile:resolve()
Constraints: ref-1
.... 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
Constraints: ext-1
...... extension:commentContactReason O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ΣC 0..* Reference(nl core Problem) Problem
Constraints: ref-1
.... reasonReference:procedure OΣC 0..* Reference(nl core Procedure event) Procedure
Constraints: ref-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition ΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ref-1
.... 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
Constraints: ref-1
... 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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin C 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Constraints: ref-1
.... admitSource 0..1 CodeableConcept Origin
Binding: HerkomstCodelijst (2020-09-01T00:00:00) (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: Hl7VSReAdmissionIndicator (2.0.0) (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
Constraints: ref-1
.... dischargeDisposition 0..1 CodeableConcept Destination
Binding: BestemmingCodelijst (2020-09-01T00:00:00) (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
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location C 1..1 Reference(Location | nl core HealthcareProvider) Location
Constraints: ref-1
.... 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
Constraints: per-1
... serviceProvider C 0..1 Reference(Organization) The organization (facility) responsible for this encounter
Constraints: ref-1
... partOf C 0..1 Reference(Encounter) Another Encounter this encounter is part of
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
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.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type|4.0.1
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type|4.0.1
From the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1
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|2020-09-01T00:00:00
Encounter.participant:contactPerson.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
From the FHIR Standard
Encounter.reasonCode:deviatingResultpreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
From the FHIR Standard
Encounter.reasonReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role|4.0.1
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|2020-09-01T00:00:00
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092|2.0.0
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet|4.0.1
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy|4.0.1
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements|4.0.1
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|2020-09-01T00:00:00
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|4.0.1
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-1errorEncounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.period, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.type, Encounter.participant:contactPerson.period, Encounter.participant:contactPerson.individual, Encounter.appointment, Encounter.period, Encounter.period.extension, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonCode:deviatingResult.text, Encounter.reasonReference, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference.type, Encounter.reasonReference.identifier, Encounter.reasonReference.display, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorEncounter.extension, Encounter.modifierExtension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.period.extension, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtensionMust 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.participant:contactPerson.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.participant:contactPerson.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