RIVO-Noord Zorgviewer Implementation Guide
1.27.0 - master Netherlands flag

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.27.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: Appointment

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Appointment Version: 1.27.0
Draft as of 2026-10-22 Computable Name: Appointment

Afspraak

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.

De specificatie op deze pagina is work-in-progress of gemaakt als uitwerking van een analyse als voorbeeld voor verdere discussie.

Zorginformatiebouwsteen

View Definition

ViewDefinition voor Appointment

UI Wireframe

Afspraken

Bron Datum Met Locatie Status Type Reden
CGM 15-7-2026 10:00 - 10:15 Pharmeon acceptatie zorgverlener
Huisartsen, niet apotheekhoudend		 booked e-consult
WZA 13-7-2026 15:00 - 15:05 M.C. Gordinou de Gouberville
Onbekende functiecode.		 Wilhelmina Ziekenhuis pending Ambulatory Niet beschikbaar
Chipsoft 12-10-2022 11:30 - 11:40 Ziekenhuis Apotheek pending Ambulatory Niet beschikbaar
Epic 20-4-2018 11:10 - 11:15 G. Dijkstra, MDL arts Maag- Darm- Leverziekten pending Ambulatory

Gegevensherkomst

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
Datum iif(start.exists() and end.exists(), start.toString() + ' - ' + end.toString(), start | end) Period BeginDatumTijd - EindDatumTijd
Met participant.actor.where(reference.contains('Practitioner/')).select(display | extension('http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference').valueReference.display).join(' ') string ContactMet::Zorgverlener, ContactMet::Zorgverlener/ZorgverlenersRol
Locatie participant.actor.where(reference.contains('Location/'))[0].display string Locatie::Zorgaanbieder
Status status code GeplandeZorgActiviteit::OrderStatus
Type appointmentType.coding.display string ContactType
Reden reason.text | indication.display string nvt DeviatingResult or Problem or Condition
n.b. dit is geen ZIB.

Request

  1. Opvragen (search) afspraken (BgZ)

    GET <ontsluiten-bronsysteem-base>/Appointment?status=booked,pending,proposed

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:

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: doco
Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-3, app-2
Appointment.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
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Appointment.participant.status 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📍3.0.2 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.empty() xor end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))
dom-1 error Appointment If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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())

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-3, app-2
Appointment.id This element is included in summaries. 0..1 id Logical id of this artifact
Appointment.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Appointment.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
Appointment.language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
Appointment.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
Appointment.contained 0..* Resource Contained, inline Resources
Appointment.extension 0..* Extension Additional Content defined by implementations
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.identifier This element is included in summaries. 0..* Identifier External Ids for this item
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.serviceCategory This element is included in summaries. 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
Appointment.serviceType This element is included in summaries. 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
Appointment.specialty This element is included in summaries. 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred)
Appointment.appointmentType This element is included in summaries. 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: v2 Appointment reason codes (preferred)
Appointment.reason This element is included in summaries. 0..* CodeableConcept Reason this appointment is scheduled
Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place.
Appointment.indication 0..* Reference(Condition | Procedure) Reason the appointment is to takes place (resource)
Appointment.priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
Appointment.description 0..1 string Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation 0..* Reference(Resource) Additional information to support the appointment
Appointment.start This element is included in summaries. 0..1 instant When appointment is to take place
Appointment.end This element is included in summaries. 0..1 instant When appointment is to conclude
Appointment.minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
Appointment.slot 0..* Reference(Slot) The slots that this appointment is filling
Appointment.created 0..1 dateTime The date that this appointment was initially created
Appointment.comment 0..1 string Additional comments
Appointment.incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest provided as information to allocate to the Encounter
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.id 0..1 string xml:id (or equivalent in JSON)
Appointment.participant.extension 0..* Extension Additional Content defined by implementations
Appointment.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Appointment.participant.type This element is included in summaries. 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
Appointment.participant.actor This element is included in summaries. 0..1 Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
Appointment.participant.required This element is included in summaries. 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.participant.status 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Appointment.status Base required AppointmentStatus 📍3.0.2 FHIR Std.
Appointment.serviceCategory Base example ServiceCategory 📍3.0.2 FHIR Std.
Appointment.serviceType Base example ServiceType 📍3.0.2 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍20091109 FHIR Std.
Appointment.appointmentType Base preferred v2 Appointment reason codes 📍2.8.2 FHIR Std.
Appointment.reason Base preferred Encounter Reason Codes 📍3.0.2 FHIR Std.
Appointment.participant.​type Base extensible ParticipantType 📍3.0.2 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍3.0.2 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.empty() xor end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))
dom-1 error Appointment If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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())

This structure is derived from Appointment

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-3, app-2
Appointment.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
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Appointment.participant.status 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📍3.0.2 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.empty() xor end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))
dom-1 error Appointment If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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())

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-3, app-2
Appointment.id This element is included in summaries. 0..1 id Logical id of this artifact
Appointment.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Appointment.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
Appointment.language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
Appointment.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
Appointment.contained 0..* Resource Contained, inline Resources
Appointment.extension 0..* Extension Additional Content defined by implementations
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.identifier This element is included in summaries. 0..* Identifier External Ids for this item
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required): The free/busy status of an appointment.
Appointment.serviceCategory This element is included in summaries. 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
Appointment.serviceType This element is included in summaries. 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
Appointment.specialty This element is included in summaries. 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred)
Appointment.appointmentType This element is included in summaries. 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: v2 Appointment reason codes (preferred)
Appointment.reason This element is included in summaries. 0..* CodeableConcept Reason this appointment is scheduled
Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place.
Appointment.indication 0..* Reference(Condition | Procedure) Reason the appointment is to takes place (resource)
Appointment.priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
Appointment.description 0..1 string Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation 0..* Reference(Resource) Additional information to support the appointment
Appointment.start This element is included in summaries. 0..1 instant When appointment is to take place
Appointment.end This element is included in summaries. 0..1 instant When appointment is to conclude
Appointment.minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
Appointment.slot 0..* Reference(Slot) The slots that this appointment is filling
Appointment.created 0..1 dateTime The date that this appointment was initially created
Appointment.comment 0..1 string Additional comments
Appointment.incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest provided as information to allocate to the Encounter
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.id 0..1 string xml:id (or equivalent in JSON)
Appointment.participant.extension 0..* Extension Additional Content defined by implementations
Appointment.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Appointment.participant.type This element is included in summaries. 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
Appointment.participant.actor This element is included in summaries. 0..1 Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
Appointment.participant.required This element is included in summaries. 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.participant.status 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Appointment.status Base required AppointmentStatus 📍3.0.2 FHIR Std.
Appointment.serviceCategory Base example ServiceCategory 📍3.0.2 FHIR Std.
Appointment.serviceType Base example ServiceType 📍3.0.2 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍20091109 FHIR Std.
Appointment.appointmentType Base preferred v2 Appointment reason codes 📍2.8.2 FHIR Std.
Appointment.reason Base preferred Encounter Reason Codes 📍3.0.2 FHIR Std.
Appointment.participant.​type Base extensible ParticipantType 📍3.0.2 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍3.0.2 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.empty() xor end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))
dom-1 error Appointment If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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())

This structure is derived from Appointment

Summary

 

Other representations of profile: CSV, Excel, Schematron

Notes:

eAfspraak Dependency Issue

Door een issue in de eAfspraak package van Nictiz kunnen we nu niet onderstaande toevoegen. Het issue heeft te maken met de dependency van eAfspraak met de wildcard versie 2.0.x van de zibs package. Tot 15-jan-2026 (IG Publisher v2.0.29) werkte het correct. Vanaf die datum lijkt het niet meer te werken. Na wat verder kijken lijkt het niet de IG Publisher versie te zijn, maar iets met de packages.

StructureDefinition-Appointment.json:

  "baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment"

CapabilityStatement-OntsluitenBronsysteem.json:

  "profile": [
    {
      "reference": "http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment",
      "display": "eAfspraak-Appointment"
    } ]

zorgviewer-ig.json:

  "dependsOn": [
    {
      "id": "eafspraak",
      "uri": "https://simplifier.net/packages/nictiz.fhir.nl.stu3.eafspraak/1.0.6",
      "packageId": "nictiz.fhir.nl.stu3.eafspraak",
      "version": "1.0.6"
    } ]