Dit profiel is het resultaat van de vergelijking tussen de zib2017 STU3 en zibs2020 R4 FHIR Profiel, relevante informatiestandarden en de implementaties in de ontsloten systemen en instellingen. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

ZIB Contact

View Definition

ViewDefinition voor Encounter

UI Wireframe

Contacten

Gegevensherkomst

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,http://hl7.org/fhir/v3/ActCode|AMB

2. Opvragen (search) afspraken (Sanday)

   GET <ontsluiten-bronsysteem-base>/Encounter

CGM: gebruikt het gp-Encounter profiel, die compatibel is met de Zib Encounter en codeert het type contact via NHG Tabel 14 (contactwijze).

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.

• 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
Encounter.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter
Encounter.class	Σ This element is included in summaries.	1..1	Coding	ContactType Binding: ContactTypeCodelijst (extensible): ContactTypeCodelijst
Encounter.class.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Encounter.subject	Σ This element is included in summaries.	1..1	Reference(nl-core-patient)	The patient ro group present at the encounter
Encounter.participant	S This element must be supported. Σ This element is included in summaries.	0..*	BackboneElement	List of participants involved in the encounter
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.participant.individual	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(nl-core-relatedperson | nl-core-practitioner)	ContactWith
Encounter.participant.individual.Slices for extension				Content/Rules for all slices
Encounter.participant.individual.Slices for extension.extension:practitionerRole	S This element must be supported.	0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Encounter.participant.individual.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.period	S This element must be supported.	0..1	Period	The start and end time of the encounter
Encounter.period.start	S This element must be supported. Σ This element is included in summaries. C	1..1	dateTime	StartDateTime
Encounter.period.end	S This element must be supported. Σ This element is included in summaries. C	0..1	dateTime	EndDateTime
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.location.location	S This element must be supported.	1..1	Reference(Location)	Location the encounter takes place
Encounter.location.location.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
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()
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Zib Encounter	Encounter
Encounter.status	S This element must be supported.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Encounter.class
Encounter.class.display	S This element must be supported.	0..1	string	Representation defined by the system
Encounter.participant	S This element must be supported.	0..*	BackboneElement	List of participants involved in the encounter
Encounter.participant.individual	S This element must be supported.	0..1	Reference(nl-core-relatedperson | nl-core-practitioner)	ContactWith
Encounter.participant.individual.Slices for extension				Content/Rules for all slices
Encounter.participant.individual.Slices for extension.extension:practitionerRole	S This element must be supported.	0..1	PractitionerRole Reference	Optional Extensions Element
Encounter.participant.individual.display	S This element must be supported.	0..1	string	Text alternative for the resource
Encounter.period	S This element must be supported.	0..1	Period	The start and end time of the encounter
Encounter.period.start	S This element must be supported.	1..1	dateTime	StartDateTime
Encounter.period.end	S This element must be supported.	0..1	dateTime	EndDateTime
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.location	S This element must be supported.	1..1	Reference(Location)	Location the encounter takes place
Encounter.location.location.display	S This element must be supported.	0..1	string	Text alternative for the resource
Documentation for this format

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Zib Encounter	Encounter
Encounter.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter
Encounter.class	Σ This element is included in summaries.	1..1	Coding	ContactType Binding: ContactTypeCodelijst (extensible): ContactTypeCodelijst
Encounter.class.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Encounter.subject	Σ This element is included in summaries.	1..1	Reference(nl-core-patient)	The patient ro group present at the encounter
Encounter.participant	S This element must be supported. Σ This element is included in summaries.	0..*	BackboneElement	List of participants involved in the encounter
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.participant.individual	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(nl-core-relatedperson | nl-core-practitioner)	ContactWith
Encounter.participant.individual.Slices for extension				Content/Rules for all slices
Encounter.participant.individual.Slices for extension.extension:practitionerRole	S This element must be supported.	0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Encounter.participant.individual.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.period	S This element must be supported.	0..1	Period	The start and end time of the encounter
Encounter.period.start	S This element must be supported. Σ This element is included in summaries. C	1..1	dateTime	StartDateTime
Encounter.period.end	S This element must be supported. Σ This element is included in summaries. C	0..1	dateTime	EndDateTime
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.location.location	S This element must be supported.	1..1	Reference(Location)	Location the encounter takes place
Encounter.location.location.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text alternative for the resource
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()
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()

Differential View

This structure is derived from Zib Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Zib Encounter	Encounter
Encounter.status	S This element must be supported.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Encounter.class
Encounter.class.display	S This element must be supported.	0..1	string	Representation defined by the system
Encounter.participant	S This element must be supported.	0..*	BackboneElement	List of participants involved in the encounter
Encounter.participant.individual	S This element must be supported.	0..1	Reference(nl-core-relatedperson | nl-core-practitioner)	ContactWith
Encounter.participant.individual.Slices for extension				Content/Rules for all slices
Encounter.participant.individual.Slices for extension.extension:practitionerRole	S This element must be supported.	0..1	PractitionerRole Reference	Optional Extensions Element
Encounter.participant.individual.display	S This element must be supported.	0..1	string	Text alternative for the resource
Encounter.period	S This element must be supported.	0..1	Period	The start and end time of the encounter
Encounter.period.start	S This element must be supported.	1..1	dateTime	StartDateTime
Encounter.period.end	S This element must be supported.	0..1	dateTime	EndDateTime
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.location	S This element must be supported.	1..1	Reference(Location)	Location the encounter takes place
Encounter.location.location.display	S This element must be supported.	0..1	string	Text alternative for the resource
Documentation for this format

Snapshot View

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

Must-Support: 12 elements