RIVO-Noord Zorgviewer Implementation Guide
1.21.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.21.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.21.0
Draft as of 2025-10-28 | 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.20.0:

- No changes

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | eAfspraakAppointment | 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
Slices for extension |  |  |  | Content/Rules for all slices
extension:PatientInstructions |  | 0..* | string | ContactPatientInstructions URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-PatientInstructions
extension:OnlineEditable |  | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable
Slices for extension |  |  |  | Content/Rules for all slices
extension:Indicator |  | 0..1 | Extension | Extension
url |  | 1..1 | uri | "Indicator"
Slices for value[x] |  | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean |  | 0..1 | boolean | Value of extension
extension:OnlineEditableUntil |  | 0..1 | Extension | Extension
url |  | 1..1 | uri | "OnlineEditableUntil"
Slices for value[x] |  | 0..1 | dateTime | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueDateTime |  | 0..1 | dateTime | Value of extension
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | IdentificationNumber
status | ?!Σ | 1..1 | code | ContactStatus Binding: AppointmentStatus (required): The free/busy status of an appointment.
Slices for extension |  |  |  | Content/Rules for all slices
extension:OrderStatus |  | 0..1 | (Complex) | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: OrderStatusCodelijst (extensible): The status of the order.
Slices for specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Slice: Unordered, Open by value:coding.system Binding: Practice Setting Code Value Set (preferred)
specialty:specialtyAGB | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeAGBCodelijst (required): Specific specialty associated with the agency
specialty:specialtyUZI | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeUZICodelijst (required): Specific specialty associated with the agency
participant | C | 1..* | BackboneElement | ContactWith Constraints: app-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
status |  | 1..1 | code | ContactWithStatus Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Appointment.status | Base | required | AppointmentStatus | 📍3.0.2 | FHIR Std.
Appointment.status.extension:OrderStatus.​value[x]:valueCodeableConcept | Base | extensible | OrderStatusCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍20091109 | FHIR Std.
Appointment.specialty:specialtyAGB | Base | required | SpecialismeAGBCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.specialty:specialtyUZI | Base | required | SpecialismeUZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from eAfspraakAppointment

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Appointment |  | 0..* | eAfspraakAppointment | 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)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | eAfspraakAppointment | 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 Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:PatientInstructions |  | 0..* | string | ContactPatientInstructions URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-PatientInstructions
extension:OnlineEditable |  | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:Indicator |  | 0..1 | Extension | Extension
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "Indicator"
Slices for value[x] |  | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean |  | 0..1 | boolean | Value of extension
extension:OnlineEditableUntil |  | 0..1 | Extension | Extension
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "OnlineEditableUntil"
Slices for value[x] |  | 0..1 | dateTime | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueDateTime |  | 0..1 | dateTime | Value of extension
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | IdentificationNumber
status | ?!Σ | 1..1 | code | ContactStatus Binding: AppointmentStatus (required): The free/busy status of an appointment.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OrderStatus |  | 0..1 | (Complex) | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: OrderStatusCodelijst (extensible): The status of the order.
value |  | 0..1 | code | Primitive value for code
serviceCategory | Σ | 0..1 | CodeableConcept | ContactCategory Binding: ServiceCategory (example)
serviceType | Σ | 0..* | CodeableConcept | ContactProcedureType Binding: ServiceType (example)
Slices for specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Slice: Unordered, Open by value:coding.system Binding: Practice Setting Code Value Set (preferred)
specialty:specialtyAGB | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeAGBCodelijst (required): Specific specialty associated with the agency
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.6.7
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
specialty:specialtyUZI | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeUZICodelijst (required): Specific specialty associated with the agency
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-rolcode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
appointmentType | Σ | 0..1 | CodeableConcept | ContactType Binding: ContactTypeCodelijst_en_NHGTable14v7-ContactType (extensible): ContactType and NHGTable14v7-ContactType
reason | Σ | 0..* | CodeableConcept | DeviatingResult Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place.
indication |  | 0..* | Reference(Condition | Procedure) | Procedure | Problem
priority |  | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize
description |  | 0..1 | string | ContactSubject
supportingInformation |  | 0..* | Reference(Resource) | Additional information to support the appointment
start | Σ | 0..1 | instant | StartDateTime
end | Σ | 0..1 | instant | EndDateTime
minutesDuration |  | 0..1 | positiveInt | ContactDuration
slot |  | 0..* | Reference(Slot) | The slots that this appointment is filling
created |  | 0..1 | dateTime | DateTime
comment |  | 0..1 | string | ContactDescription
incomingReferral |  | 0..* | Reference(ReferralRequest) | The ReferralRequest provided as information to allocate to the Encounter
participant | C | 1..* | BackboneElement | ContactWith 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.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:healthProfessionalRole | Σ | 0..* | Coding | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (required)
text | Σ | 0..1 | string | Plain text representation of the concept
actor | Σ | 0..1 | Reference(nl-core-patient(2.2.5) | nl-core-practitioner(2.0.7) | nl-core-relatedperson(2.0.5) | Device | HealthcareService | nl-core-location(2.0.5)) | Person, Location/HealthcareService or Device
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole(2.0.7)) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
required | Σ | 0..1 | code | ContactWithRequired Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status |  | 1..1 | code | ContactWithStatus Binding: ParticipationStatus (required): The Participation status of an appointment.
requestedPeriod |  | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within
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.status.extension:OrderStatus.​value[x]:valueCodeableConcept | Base | extensible | OrderStatusCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
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.specialty:specialtyAGB | Base | required | SpecialismeAGBCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.specialty:specialtyUZI | Base | required | SpecialismeUZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.appointmentType | Base | extensible | ContactTypeCodelijst_en_NHGTable14v7-ContactType | 📦2022-03-22T00:00:00 | Nictiz FHIR NL STU3 eAfspraak v1.0
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.​type.coding:healthProfessionalRole | Base | required | ZorgverlenerRolCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from eAfspraakAppointment

Summary

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | eAfspraakAppointment | 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
Slices for extension |  |  |  | Content/Rules for all slices
extension:PatientInstructions |  | 0..* | string | ContactPatientInstructions URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-PatientInstructions
extension:OnlineEditable |  | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable
Slices for extension |  |  |  | Content/Rules for all slices
extension:Indicator |  | 0..1 | Extension | Extension
url |  | 1..1 | uri | "Indicator"
Slices for value[x] |  | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean |  | 0..1 | boolean | Value of extension
extension:OnlineEditableUntil |  | 0..1 | Extension | Extension
url |  | 1..1 | uri | "OnlineEditableUntil"
Slices for value[x] |  | 0..1 | dateTime | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueDateTime |  | 0..1 | dateTime | Value of extension
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | IdentificationNumber
status | ?!Σ | 1..1 | code | ContactStatus Binding: AppointmentStatus (required): The free/busy status of an appointment.
Slices for extension |  |  |  | Content/Rules for all slices
extension:OrderStatus |  | 0..1 | (Complex) | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: OrderStatusCodelijst (extensible): The status of the order.
Slices for specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Slice: Unordered, Open by value:coding.system Binding: Practice Setting Code Value Set (preferred)
specialty:specialtyAGB | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeAGBCodelijst (required): Specific specialty associated with the agency
specialty:specialtyUZI | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeUZICodelijst (required): Specific specialty associated with the agency
participant | C | 1..* | BackboneElement | ContactWith Constraints: app-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
status |  | 1..1 | code | ContactWithStatus Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Appointment.status | Base | required | AppointmentStatus | 📍3.0.2 | FHIR Std.
Appointment.status.extension:OrderStatus.​value[x]:valueCodeableConcept | Base | extensible | OrderStatusCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍20091109 | FHIR Std.
Appointment.specialty:specialtyAGB | Base | required | SpecialismeAGBCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.specialty:specialtyUZI | Base | required | SpecialismeUZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from eAfspraakAppointment

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Appointment |  | 0..* | eAfspraakAppointment | 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)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Appointment | C | 0..* | eAfspraakAppointment | 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 Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:PatientInstructions |  | 0..* | string | ContactPatientInstructions URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-PatientInstructions
extension:OnlineEditable |  | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:Indicator |  | 0..1 | Extension | Extension
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "Indicator"
Slices for value[x] |  | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean |  | 0..1 | boolean | Value of extension
extension:OnlineEditableUntil |  | 0..1 | Extension | Extension
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "OnlineEditableUntil"
Slices for value[x] |  | 0..1 | dateTime | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueDateTime |  | 0..1 | dateTime | Value of extension
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | IdentificationNumber
status | ?!Σ | 1..1 | code | ContactStatus Binding: AppointmentStatus (required): The free/busy status of an appointment.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OrderStatus |  | 0..1 | (Complex) | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: OrderStatusCodelijst (extensible): The status of the order.
value |  | 0..1 | code | Primitive value for code
serviceCategory | Σ | 0..1 | CodeableConcept | ContactCategory Binding: ServiceCategory (example)
serviceType | Σ | 0..* | CodeableConcept | ContactProcedureType Binding: ServiceType (example)
Slices for specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Slice: Unordered, Open by value:coding.system Binding: Practice Setting Code Value Set (preferred)
specialty:specialtyAGB | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeAGBCodelijst (required): Specific specialty associated with the agency
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.6.7
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
specialty:specialtyUZI | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: SpecialismeUZICodelijst (required): Specific specialty associated with the agency
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-rolcode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
appointmentType | Σ | 0..1 | CodeableConcept | ContactType Binding: ContactTypeCodelijst_en_NHGTable14v7-ContactType (extensible): ContactType and NHGTable14v7-ContactType
reason | Σ | 0..* | CodeableConcept | DeviatingResult Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place.
indication |  | 0..* | Reference(Condition | Procedure) | Procedure | Problem
priority |  | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize
description |  | 0..1 | string | ContactSubject
supportingInformation |  | 0..* | Reference(Resource) | Additional information to support the appointment
start | Σ | 0..1 | instant | StartDateTime
end | Σ | 0..1 | instant | EndDateTime
minutesDuration |  | 0..1 | positiveInt | ContactDuration
slot |  | 0..* | Reference(Slot) | The slots that this appointment is filling
created |  | 0..1 | dateTime | DateTime
comment |  | 0..1 | string | ContactDescription
incomingReferral |  | 0..* | Reference(ReferralRequest) | The ReferralRequest provided as information to allocate to the Encounter
participant | C | 1..* | BackboneElement | ContactWith 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.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:healthProfessionalRole | Σ | 0..* | Coding | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (required)
text | Σ | 0..1 | string | Plain text representation of the concept
actor | Σ | 0..1 | Reference(nl-core-patient(2.2.5) | nl-core-practitioner(2.0.7) | nl-core-relatedperson(2.0.5) | Device | HealthcareService | nl-core-location(2.0.5)) | Person, Location/HealthcareService or Device
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole(2.0.7)) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
required | Σ | 0..1 | code | ContactWithRequired Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status |  | 1..1 | code | ContactWithStatus Binding: ParticipationStatus (required): The Participation status of an appointment.
requestedPeriod |  | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within
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.status.extension:OrderStatus.​value[x]:valueCodeableConcept | Base | extensible | OrderStatusCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
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.specialty:specialtyAGB | Base | required | SpecialismeAGBCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.specialty:specialtyUZI | Base | required | SpecialismeUZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Appointment.appointmentType | Base | extensible | ContactTypeCodelijst_en_NHGTable14v7-ContactType | 📦2022-03-22T00:00:00 | Nictiz FHIR NL STU3 eAfspraak v1.0
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.​type.coding:healthProfessionalRole | Base | required | ZorgverlenerRolCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from eAfspraakAppointment

Summary

Other representations of profile: CSV, Excel, Schematron