RIVO-Noord Zorgviewer Implementation Guide
1.23.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.23.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Encounter

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Encounter | Version: 1.23.0
Draft as of 2026-03-30 | Computable Name: Encounter

Contact

> Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

### Zorginformatiebouwsteen

ZIB Contact

### View Definition

ViewDefinition voor Encounter

### UI Wireframe

Contacten

>< | Bron | Begin | Eind | Met | Rol | Locatie | Status | Type
--- | --- | --- | --- | --- | --- | --- | --- | ---
+ | Chipsoft | 14-8-2012 | 15-8-2012 | J.H.R Peters | Onbekende functiecode. |  | finished | inpatient
+ | Epic | 27-3-2025 | 27-3-2025 | E. Sieders, Chirurg |  | UMCG HC | unknown | Inpatient Encounter
+ | Nexus | 16-8-2012 | 19-8-2012 | Wit | Orthopedie |  | finished | Klinisch

### Kolomdefinities

Kolom label | FHIR Path Expression | FHIR Type | Zib element | Toelichting of regels
Bron | `meta.extension('http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source').valueUri` | `string` | nvt | Lookup adhv uri (AGB-Z of OID) `<adressering-base>/Organization?identifier=<.meta.tag.code>` en gebruik dan `Organization.name`
Begin | `period.start` | `dateTime` | BeginDatumTijd |
Eind | `period.end` | `dateTime` | EindDatumTijd |
Met | `participant.individual.display` | `string` | ContactMet::Zorgverlener |
Rol | `participant.individual.extension('http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference').valueReference.display` | `string` | nvt |
Locatie | `location.location.display` | `string` | Locatie::Zorgaanbieder |
Status | `status` | `code` | nvt |
Type | `class.display` | `code` | ContactType |

### Request

1. Opvragen (search) contacten inclusief ziekenhuis opnames

   `GET <ontsluiten-bronsysteem-base>/Encounter?class=http://hl7.org/fhir/v3/ActCode|IMP,http://hl7.org/fhir/v3/ActCode|ACUTE,http://hl7.org/fhir/v3/ActCode|NONAC`

### Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

    "meta": {
        "extension": [ {
            "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
            "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
        } ]
    }

Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (`<resource>.subject|patient`). Elke patient heeft een `Patient.managingOrganization` en in de gerefereerde `Organization.identifier` staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

Usages:

- CapabilityStatements using this Profile: Ontsluiten Bronsysteem
- This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 1.22.0:

- No changes

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Zib Encounter | Encounter
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter
class | Σ | 1..1 | Coding | ContactType Binding: ContactTypeCodelijst (extensible): ContactTypeCodelijst
subject | Σ | 1..1 | Reference(nl-core-patient) | The patient ro group present at the encounter
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.status | Base | required | EncounterStatus | 📦3.0.2 | FHIR Std.
Encounter.class | Base | extensible | ContactTypeCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | `contained.where(('#'+id in %resource.descendants().reference).not()).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`

This structure is derived from Zib Encounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Zib Encounter | Encounter
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Zib Encounter | 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: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 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 | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter
period |  | 1..1 | Period | The time that the episode was in the specified status
class | Σ | 1..1 | Coding | ContactType Binding: ContactTypeCodelijst (extensible): ContactTypeCodelijst
classHistory |  | 0..* | BackboneElement | List of past encounter classes
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
class |  | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter
period |  | 1..1 | Period | The time that the episode was in the specified class
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject | Σ | 1..1 | Reference(nl-core-patient) | The patient ro group present at the encounter
episodeOfCare | Σ | 0..* | Reference(nl-core-episodeofcare) | Episode(s) of care that this encounter should be recorded against
incomingReferral |  | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:healthProfessionalRole | Σ | 0..* | Coding | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (required)
text | Σ | 0..1 | string | Plain text representation of the concept
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | Σ | 0..1 | Reference(nl-core-relatedperson | nl-core-practitioner) | ContactWith
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter
period |  | 0..1 | Period | The start and end time of the encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
start | Σ C | 1..1 | dateTime | StartDateTime
end | Σ C | 0..1 | dateTime | EndDateTime
length |  | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reason | Σ | 0..* | CodeableConcept | DeviatingResult Binding: Encounter Reason Codes (preferred): Reason why the encounter takes place.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | DeviatingResult
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
condition |  | 1..1 | Reference(HCIM Procedure | HCIM Problem) | ContactReason
role |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents
rank |  | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
account |  | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter
hospitalization |  | 0..1 | BackboneElement | Details about the admission to a healthcare service
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
preAdmissionIdentifier |  | 0..1 | Identifier | Pre-admission identifier
origin |  | 0..1 | Reference(Location) | The location from which the patient came before admission
admitSource |  | 0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (extensible): HerkomstCodelijst
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: v2 Re-Admission Indicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference |  | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy |  | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies
specialArrangement |  | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements
destination |  | 0..1 | Reference(Location) | Location to which the patient is discharged
dischargeDisposition |  | 0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (extensible): BestemmingCodelijst
location |  | 0..* | BackboneElement | List of locations where the patient has been
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
location |  | 1..1 | Reference(Location) | Location the encounter takes place
status |  | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
period |  | 0..1 | Period | Time period during which the patient was present at the location
serviceProvider |  | 0..1 | Reference(nl-core-organization) | Location
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.language | Base | extensible | Common Languages | 📦3.0.2 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📦3.0.2 | FHIR Std.
Encounter.statusHistory.​status | Base | required | EncounterStatus | 📦3.0.2 | FHIR Std.
Encounter.class | Base | extensible | ContactTypeCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📦2014-03-26 | FHIR Std.
Encounter.type | Base | example | EncounterType | 📦3.0.2 | FHIR Std.
Encounter.priority | Base | example | v3 Code System ActPriority | 📦2016-11-11 | FHIR Std.
Encounter.participant.​type | Base | extensible | ParticipantType | 📦3.0.2 | FHIR Std.
Encounter.participant.​type.coding:healthProfessionalRole | Base | required | ZorgverlenerRolCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.reason | Base | preferred | Encounter Reason Codes | 📦3.0.2 | FHIR Std.
Encounter.diagnosis.​role | Base | preferred | DiagnosisRole | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | extensible | HerkomstCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.hospitalization.​reAdmission | Base | example | v2 Re-Admission Indicator | 📦2.8.2 | FHIR Std.
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | SpecialCourtesy | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | SpecialArrangements | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | extensible | BestemmingCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.location.status | Base | required | EncounterLocationStatus | 📦3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | `contained.where(('#'+id in %resource.descendants().reference).not()).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() | (children().count() > id.count())`
ext-1 | error | Encounter.participant.individual.extension:practitionerRole | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Zib Encounter

Summary

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Zib Encounter | Encounter
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter
class | Σ | 1..1 | Coding | ContactType Binding: ContactTypeCodelijst (extensible): ContactTypeCodelijst
subject | Σ | 1..1 | Reference(nl-core-patient) | The patient ro group present at the encounter
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.status | Base | required | EncounterStatus | 📦3.0.2 | FHIR Std.
Encounter.class | Base | extensible | ContactTypeCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | `contained.where(('#'+id in %resource.descendants().reference).not()).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`

Differential View

This structure is derived from Zib Encounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Zib Encounter | Encounter
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Zib Encounter | 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: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 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 | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter
period |  | 1..1 | Period | The time that the episode was in the specified status
class | Σ | 1..1 | Coding | ContactType Binding: ContactTypeCodelijst (extensible): ContactTypeCodelijst
classHistory |  | 0..* | BackboneElement | List of past encounter classes
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
class |  | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter
period |  | 1..1 | Period | The time that the episode was in the specified class
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject | Σ | 1..1 | Reference(nl-core-patient) | The patient ro group present at the encounter
episodeOfCare | Σ | 0..* | Reference(nl-core-episodeofcare) | Episode(s) of care that this encounter should be recorded against
incomingReferral |  | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:healthProfessionalRole | Σ | 0..* | Coding | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (required)
text | Σ | 0..1 | string | Plain text representation of the concept
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | Σ | 0..1 | Reference(nl-core-relatedperson | nl-core-practitioner) | ContactWith
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter
period |  | 0..1 | Period | The start and end time of the encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
start | Σ C | 1..1 | dateTime | StartDateTime
end | Σ C | 0..1 | dateTime | EndDateTime
length |  | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reason | Σ | 0..* | CodeableConcept | DeviatingResult Binding: Encounter Reason Codes (preferred): Reason why the encounter takes place.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | DeviatingResult
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
condition |  | 1..1 | Reference(HCIM Procedure | HCIM Problem) | ContactReason
role |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents
rank |  | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
account |  | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter
hospitalization |  | 0..1 | BackboneElement | Details about the admission to a healthcare service
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
preAdmissionIdentifier |  | 0..1 | Identifier | Pre-admission identifier
origin |  | 0..1 | Reference(Location) | The location from which the patient came before admission
admitSource |  | 0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (extensible): HerkomstCodelijst
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: v2 Re-Admission Indicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference |  | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy |  | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies
specialArrangement |  | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements
destination |  | 0..1 | Reference(Location) | Location to which the patient is discharged
dischargeDisposition |  | 0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (extensible): BestemmingCodelijst
location |  | 0..* | BackboneElement | List of locations where the patient has been
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
location |  | 1..1 | Reference(Location) | Location the encounter takes place
status |  | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
period |  | 0..1 | Period | Time period during which the patient was present at the location
serviceProvider |  | 0..1 | Reference(nl-core-organization) | Location
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.language | Base | extensible | Common Languages | 📦3.0.2 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📦3.0.2 | FHIR Std.
Encounter.statusHistory.​status | Base | required | EncounterStatus | 📦3.0.2 | FHIR Std.
Encounter.class | Base | extensible | ContactTypeCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📦2014-03-26 | FHIR Std.
Encounter.type | Base | example | EncounterType | 📦3.0.2 | FHIR Std.
Encounter.priority | Base | example | v3 Code System ActPriority | 📦2016-11-11 | FHIR Std.
Encounter.participant.​type | Base | extensible | ParticipantType | 📦3.0.2 | FHIR Std.
Encounter.participant.​type.coding:healthProfessionalRole | Base | required | ZorgverlenerRolCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.reason | Base | preferred | Encounter Reason Codes | 📦3.0.2 | FHIR Std.
Encounter.diagnosis.​role | Base | preferred | DiagnosisRole | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | extensible | HerkomstCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.hospitalization.​reAdmission | Base | example | v2 Re-Admission Indicator | 📦2.8.2 | FHIR Std.
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | SpecialCourtesy | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | SpecialArrangements | 📦3.0.2 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | extensible | BestemmingCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3
Encounter.location.status | Base | required | EncounterLocationStatus | 📦3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | `contained.where(('#'+id in %resource.descendants().reference).not()).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() | (children().count() > id.count())`
ext-1 | error | Encounter.participant.individual.extension:practitionerRole | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Zib Encounter

Summary

Other representations of profile: CSV, Excel, Schematron