RIVO-Noord Zorgviewer Implementation Guide
1.23.0 - CI build 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.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: Appointment

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Appointment Version: 1.23.0
Draft as of 2026-02-04 Computable Name: Appointment

Afspraak

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 Appointment

UI Wireframe

Afspraken

>< Bron Begin Eind Met Locatie Status Type
+ Chipsoft 12-10-2022 12-10-2022 Ziekenhuis Apotheek pending Ambulatory
+ Epic 20-4-2018 20-4-2018 G. Dijkstra, MDL arts Maag- Darm- Leverziekten pending Ambulatory

Kolom Definities

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 start dateTime BeginDatumTijd
Eind end dateTime EindDatumTijd
Met participant.where(actor.reference.contains('Practitioner/'))[0].actor.display string ContactMet::Zorgverlener
Locatie participant.where(actor.reference.contains('Location/'))[0].actor.display string Locatie::Zorgaanbieder
Status status code nvt
Type appointmentType.coding.display code ContactType

Request

  1. Opvragen (search) afspraken

    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:

  • 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:

  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... 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 proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
    Binding: AppointmentStatus (required): The free/busy status of an appointment.
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... 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: Filtersdoco
    .. 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: Filtersdoco
    .. 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
    ... 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 BindingsPurpose
    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 External Ids for this item
    ... status ?!Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
    Binding: AppointmentStatus (required): The free/busy status of an appointment.
    ... serviceCategory Σ 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
    Binding: ServiceCategory (example)
    ... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
    Binding: ServiceType (example)
    ... specialty Σ 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)
    ... appointmentType Σ 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)
    ... reason Σ 0..* CodeableConcept Reason this appointment is scheduled
    Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place.
    ... indication 0..* Reference(Condition | Procedure) Reason the appointment is to takes place (resource)
    ... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
    ... description 0..1 string Shown on a subject line in a meeting request, or appointment list
    ... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
    ... start Σ 0..1 instant When appointment is to take place
    ... end Σ 0..1 instant When appointment is to conclude
    ... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
    ... slot 0..* Reference(Slot) The slots that this appointment is filling
    ... created 0..1 dateTime The date that this appointment was initially created
    ... comment 0..1 string Additional comments
    ... incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest provided as information to allocate to the Encounter
    ... participant C 1..* BackboneElement Participants involved in appointment
    Constraints: app-1
    .... 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 the appointment
    Binding: ParticipantType (extensible): Role of participant in encounter.
    .... actor Σ 0..1 Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
    .... required Σ 0..1 code required | optional | information-only
    Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
    .... status 1..1 code accepted | declined | tentative | needs-action
    Binding: ParticipationStatus (required): The Participation status of an 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: Filtersdoco
    .. 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
    ... 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 proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
    Binding: AppointmentStatus (required): The free/busy status of an appointment.
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... 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: Filtersdoco
    .. 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: Filtersdoco
    .. 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
    ... 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 BindingsPurpose
    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 External Ids for this item
    ... status ?!Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
    Binding: AppointmentStatus (required): The free/busy status of an appointment.
    ... serviceCategory Σ 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
    Binding: ServiceCategory (example)
    ... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
    Binding: ServiceType (example)
    ... specialty Σ 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)
    ... appointmentType Σ 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)
    ... reason Σ 0..* CodeableConcept Reason this appointment is scheduled
    Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place.
    ... indication 0..* Reference(Condition | Procedure) Reason the appointment is to takes place (resource)
    ... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
    ... description 0..1 string Shown on a subject line in a meeting request, or appointment list
    ... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
    ... start Σ 0..1 instant When appointment is to take place
    ... end Σ 0..1 instant When appointment is to conclude
    ... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
    ... slot 0..* Reference(Slot) The slots that this appointment is filling
    ... created 0..1 dateTime The date that this appointment was initially created
    ... comment 0..1 string Additional comments
    ... incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest provided as information to allocate to the Encounter
    ... participant C 1..* BackboneElement Participants involved in appointment
    Constraints: app-1
    .... 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 the appointment
    Binding: ParticipantType (extensible): Role of participant in encounter.
    .... actor Σ 0..1 Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
    .... required Σ 0..1 code required | optional | information-only
    Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
    .... status 1..1 code accepted | declined | tentative | needs-action
    Binding: ParticipationStatus (required): The Participation status of an 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. Dit is op het moment niet ondersteund door de IG Publisher.

    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"
    } ]