DIPS Core Implementation Guide
0.1.0 - ci-build Norway

DIPS Core Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DIPSAppointment

Official URL: http://dips.no/fhir/R4/StructureDefinition/DIPSAppointment Version: 0.1.0
Draft as of 2026-11-10 Computable Name: DIPSAppointment

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-2, app-3, app-4
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:MustOccurBefore 0..1 date DIPS: "frist for start helsehjelp" The ultimate date that an appointment must occur before
URL: http://dips.no/fhir/R4/StructureDefinition/MustOccurBefore
Appointment.Slices for extension.extension:Department 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension
Appointment.Slices for extension.extension:Location 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension
Appointment.Slices for extension.extension:Section 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension
Appointment.Slices for extension.extension:ward 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension
Appointment.Slices for extension.extension:ContactType 0..* CodeableConcept Extension
URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension
Appointment.Slices for extension.extension:LevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension
Appointment.Slices for extension.extension:NprLevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension
Appointment.Slices for extension.extension:Termination 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension
Appointment.Slices for extension.extension:Reminder 0..* boolean Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/Reminder
Appointment.Slices for extension.extension:DiagnoseGroup 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension
Appointment.Slices for extension.extension:VideoUrl 0..* string Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.Slices for identifier This element is included in summaries. 2..2 Identifier External Ids for this item
Slice: Unordered, Open by value:system
Appointment.Slices for identifier.identifier:DIPSPlannedContactId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.system This element is included in summaries. 1..1 uri DIPS: OID for planned contact id
Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.value This element is included in summaries. 1..1 string DIPS: planned contact id
Example General: 123456
Appointment.Slices for identifier.identifier:DIPSBookingId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSBookingId.system This element is included in summaries. 1..1 uri DIPS: OID for bookingId
Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSBookingId.value This element is included in summaries. 1..1 string DIPS: booking id
Example General: 123456
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow)
Binding: AppointmentStatus (required)
Appointment.start This element is included in summaries. 1..1 instant DIPS: checkin time
Appointment.slot 0..* Reference(SelfBookingSlot) DIPS: one slot for each planned activity as a contained resource
Appointment.slot.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant C 1..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 even if unrecognized
Appointment.participant.actor This element is included in summaries. 0..1 Reference(DIPSSubjectReference) Person, Location/HealthcareService or Device
Appointment.participant.actor.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant.actor.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📦4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 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.exists() = 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' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (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 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)
Appointment.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:MustOccurBefore 0..1 date DIPS: "frist for start helsehjelp" The ultimate date that an appointment must occur before
URL: http://dips.no/fhir/R4/StructureDefinition/MustOccurBefore
Appointment.Slices for extension.extension:Department 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension
Appointment.Slices for extension.extension:Location 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension
Appointment.Slices for extension.extension:Section 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension
Appointment.Slices for extension.extension:ward 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension
Appointment.Slices for extension.extension:ContactType 0..* CodeableConcept Extension
URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension
Appointment.Slices for extension.extension:LevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension
Appointment.Slices for extension.extension:NprLevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension
Appointment.Slices for extension.extension:Termination 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension
Appointment.Slices for extension.extension:Reminder 0..* boolean Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/Reminder
Appointment.Slices for extension.extension:DiagnoseGroup 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension
Appointment.Slices for extension.extension:VideoUrl 0..* string Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl
Appointment.Slices for identifier 2..2 Identifier External Ids for this item
Slice: Unordered, Open by value:system
Appointment.Slices for identifier.identifier:DIPSPlannedContactId 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.use 0..0 usual | official | temp | secondary | old (If known)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.type 0..0 Description of identifier
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.system 1..1 uri DIPS: OID for planned contact id
Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.value 1..1 string DIPS: planned contact id
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.period 0..0 Time period when id is/was valid for use
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.assigner 0..0 Organization that issued id (may be just text)
Appointment.Slices for identifier.identifier:DIPSBookingId 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSBookingId.use 0..0 usual | official | temp | secondary | old (If known)
Appointment.Slices for identifier.identifier:DIPSBookingId.type 0..0 Description of identifier
Appointment.Slices for identifier.identifier:DIPSBookingId.system 1..1 uri DIPS: OID for bookingId
Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSBookingId.value 1..1 string DIPS: booking id
Appointment.Slices for identifier.identifier:DIPSBookingId.period 0..0 Time period when id is/was valid for use
Appointment.Slices for identifier.identifier:DIPSBookingId.assigner 0..0 Organization that issued id (may be just text)
Appointment.status 1..1 code DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow)
Binding: AppointmentStatus (required)
Appointment.serviceCategory 0..0 A broad categorization of the service that is to be performed during this appointment
Appointment.serviceType 0..0 The specific service that is to be performed during this appointment
Appointment.specialty 0..0 The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType 0..0 The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode 0..0 Coded reason this appointment is scheduled
Appointment.reasonReference 0..0 Reason the appointment is to take place (resource)
Appointment.priority 0..0 Used to make informed decisions if needing to re-prioritize
Appointment.description 0..0 Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation 0..0 Additional information to support the appointment
Appointment.start 1..1 instant DIPS: checkin time
Appointment.minutesDuration 0..0 Can be less than start/end (e.g. estimate)
Appointment.slot 0..* Reference(SelfBookingSlot) DIPS: one slot for each planned activity as a contained resource
Appointment.slot.reference 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.slot.type 0..0 Type the reference refers to (e.g. "Patient")
Appointment.slot.identifier 0..0 Logical reference, when literal reference is not known
Appointment.created 0..0 The date that this appointment was initially created
Appointment.comment 0..0 Additional comments
Appointment.patientInstruction 0..0 Detailed information and instructions for the patient
Appointment.basedOn 0..0 The service request this appointment is allocated to assess
Appointment.participant 1..1 BackboneElement Participants involved in appointment
Appointment.participant.type 0..0 Role of participant in the appointment
Appointment.participant.actor 0..1 Reference(DIPSSubjectReference) Person, Location/HealthcareService or Device
Appointment.participant.actor.reference 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant.actor.identifier 1..1 Identifier Logical reference, when literal reference is not known
Appointment.participant.required 0..0 required | optional | information-only
Appointment.participant.status 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
Appointment.requestedPeriod 0..0 Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📦4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 FHIR Std.
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-2, app-3, app-4
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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages 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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:MustOccurBefore 0..1 date DIPS: "frist for start helsehjelp" The ultimate date that an appointment must occur before
URL: http://dips.no/fhir/R4/StructureDefinition/MustOccurBefore
Appointment.Slices for extension.extension:Department 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension
Appointment.Slices for extension.extension:Location 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension
Appointment.Slices for extension.extension:Section 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension
Appointment.Slices for extension.extension:ward 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension
Appointment.Slices for extension.extension:ContactType 0..* CodeableConcept Extension
URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension
Appointment.Slices for extension.extension:LevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension
Appointment.Slices for extension.extension:NprLevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension
Appointment.Slices for extension.extension:Termination 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension
Appointment.Slices for extension.extension:Reminder 0..* boolean Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/Reminder
Appointment.Slices for extension.extension:DiagnoseGroup 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension
Appointment.Slices for extension.extension:VideoUrl 0..* string Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.Slices for identifier This element is included in summaries. 2..2 Identifier External Ids for this item
Slice: Unordered, Open by value:system
Appointment.Slices for identifier.identifier:DIPSPlannedContactId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.id 0..1 string Unique id for inter-element referencing
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.system This element is included in summaries. 1..1 uri DIPS: OID for planned contact id
Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.value This element is included in summaries. 1..1 string DIPS: planned contact id
Example General: 123456
Appointment.Slices for identifier.identifier:DIPSBookingId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSBookingId.id 0..1 string Unique id for inter-element referencing
Appointment.Slices for identifier.identifier:DIPSBookingId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.Slices for identifier.identifier:DIPSBookingId.system This element is included in summaries. 1..1 uri DIPS: OID for bookingId
Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSBookingId.value This element is included in summaries. 1..1 string DIPS: booking id
Example General: 123456
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow)
Binding: AppointmentStatus (required)
Appointment.start This element is included in summaries. 1..1 instant DIPS: checkin time
Appointment.end This element is included in summaries. 0..1 instant When appointment is to conclude
Appointment.slot 0..* Reference(SelfBookingSlot) DIPS: one slot for each planned activity as a contained resource
Appointment.slot.id 0..1 string Unique id for inter-element referencing
Appointment.slot.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.slot.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.slot.display This element is included in summaries. 0..1 string Text alternative for the resource
Appointment.participant C 1..1 BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.id 0..1 string Unique id for inter-element referencing
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 even if unrecognized
Appointment.participant.actor This element is included in summaries. 0..1 Reference(DIPSSubjectReference) Person, Location/HealthcareService or Device
Appointment.participant.actor.id 0..1 string Unique id for inter-element referencing
Appointment.participant.actor.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.participant.actor.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant.actor.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Appointment.participant.actor.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Appointment.participant.actor.display This element is included in summaries. 0..1 string Text alternative for the resource
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
Appointment.participant.period 0..1 Period Participation period of the actor

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.status Base required AppointmentStatus 📦4.0.1 FHIR Std.
Appointment.participant.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 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.exists() = 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' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

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-2, app-3, app-4
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:MustOccurBefore 0..1 date DIPS: "frist for start helsehjelp" The ultimate date that an appointment must occur before
URL: http://dips.no/fhir/R4/StructureDefinition/MustOccurBefore
Appointment.Slices for extension.extension:Department 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension
Appointment.Slices for extension.extension:Location 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension
Appointment.Slices for extension.extension:Section 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension
Appointment.Slices for extension.extension:ward 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension
Appointment.Slices for extension.extension:ContactType 0..* CodeableConcept Extension
URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension
Appointment.Slices for extension.extension:LevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension
Appointment.Slices for extension.extension:NprLevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension
Appointment.Slices for extension.extension:Termination 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension
Appointment.Slices for extension.extension:Reminder 0..* boolean Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/Reminder
Appointment.Slices for extension.extension:DiagnoseGroup 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension
Appointment.Slices for extension.extension:VideoUrl 0..* string Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.Slices for identifier This element is included in summaries. 2..2 Identifier External Ids for this item
Slice: Unordered, Open by value:system
Appointment.Slices for identifier.identifier:DIPSPlannedContactId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.system This element is included in summaries. 1..1 uri DIPS: OID for planned contact id
Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.value This element is included in summaries. 1..1 string DIPS: planned contact id
Example General: 123456
Appointment.Slices for identifier.identifier:DIPSBookingId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSBookingId.system This element is included in summaries. 1..1 uri DIPS: OID for bookingId
Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSBookingId.value This element is included in summaries. 1..1 string DIPS: booking id
Example General: 123456
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow)
Binding: AppointmentStatus (required)
Appointment.start This element is included in summaries. 1..1 instant DIPS: checkin time
Appointment.slot 0..* Reference(SelfBookingSlot) DIPS: one slot for each planned activity as a contained resource
Appointment.slot.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant C 1..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 even if unrecognized
Appointment.participant.actor This element is included in summaries. 0..1 Reference(DIPSSubjectReference) Person, Location/HealthcareService or Device
Appointment.participant.actor.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant.actor.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📦4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 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.exists() = 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' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (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 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)
Appointment.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:MustOccurBefore 0..1 date DIPS: "frist for start helsehjelp" The ultimate date that an appointment must occur before
URL: http://dips.no/fhir/R4/StructureDefinition/MustOccurBefore
Appointment.Slices for extension.extension:Department 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension
Appointment.Slices for extension.extension:Location 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension
Appointment.Slices for extension.extension:Section 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension
Appointment.Slices for extension.extension:ward 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension
Appointment.Slices for extension.extension:ContactType 0..* CodeableConcept Extension
URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension
Appointment.Slices for extension.extension:LevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension
Appointment.Slices for extension.extension:NprLevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension
Appointment.Slices for extension.extension:Termination 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension
Appointment.Slices for extension.extension:Reminder 0..* boolean Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/Reminder
Appointment.Slices for extension.extension:DiagnoseGroup 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension
Appointment.Slices for extension.extension:VideoUrl 0..* string Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl
Appointment.Slices for identifier 2..2 Identifier External Ids for this item
Slice: Unordered, Open by value:system
Appointment.Slices for identifier.identifier:DIPSPlannedContactId 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.use 0..0 usual | official | temp | secondary | old (If known)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.type 0..0 Description of identifier
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.system 1..1 uri DIPS: OID for planned contact id
Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.value 1..1 string DIPS: planned contact id
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.period 0..0 Time period when id is/was valid for use
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.assigner 0..0 Organization that issued id (may be just text)
Appointment.Slices for identifier.identifier:DIPSBookingId 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSBookingId.use 0..0 usual | official | temp | secondary | old (If known)
Appointment.Slices for identifier.identifier:DIPSBookingId.type 0..0 Description of identifier
Appointment.Slices for identifier.identifier:DIPSBookingId.system 1..1 uri DIPS: OID for bookingId
Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSBookingId.value 1..1 string DIPS: booking id
Appointment.Slices for identifier.identifier:DIPSBookingId.period 0..0 Time period when id is/was valid for use
Appointment.Slices for identifier.identifier:DIPSBookingId.assigner 0..0 Organization that issued id (may be just text)
Appointment.status 1..1 code DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow)
Binding: AppointmentStatus (required)
Appointment.cancelationReason 0..0 The coded reason for the appointment being cancelled
Appointment.serviceCategory 0..0 A broad categorization of the service that is to be performed during this appointment
Appointment.serviceType 0..0 The specific service that is to be performed during this appointment
Appointment.specialty 0..0 The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType 0..0 The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode 0..0 Coded reason this appointment is scheduled
Appointment.reasonReference 0..0 Reason the appointment is to take place (resource)
Appointment.priority 0..0 Used to make informed decisions if needing to re-prioritize
Appointment.description 0..0 Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation 0..0 Additional information to support the appointment
Appointment.start 1..1 instant DIPS: checkin time
Appointment.minutesDuration 0..0 Can be less than start/end (e.g. estimate)
Appointment.slot 0..* Reference(SelfBookingSlot) DIPS: one slot for each planned activity as a contained resource
Appointment.slot.reference 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.slot.type 0..0 Type the reference refers to (e.g. "Patient")
Appointment.slot.identifier 0..0 Logical reference, when literal reference is not known
Appointment.created 0..0 The date that this appointment was initially created
Appointment.comment 0..0 Additional comments
Appointment.patientInstruction 0..0 Detailed information and instructions for the patient
Appointment.basedOn 0..0 The service request this appointment is allocated to assess
Appointment.participant 1..1 BackboneElement Participants involved in appointment
Appointment.participant.type 0..0 Role of participant in the appointment
Appointment.participant.actor 0..1 Reference(DIPSSubjectReference) Person, Location/HealthcareService or Device
Appointment.participant.actor.reference 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant.actor.identifier 1..1 Identifier Logical reference, when literal reference is not known
Appointment.participant.required 0..0 required | optional | information-only
Appointment.participant.status 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
Appointment.requestedPeriod 0..0 Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings (Differential)

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

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-2, app-3, app-4
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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages 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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:MustOccurBefore 0..1 date DIPS: "frist for start helsehjelp" The ultimate date that an appointment must occur before
URL: http://dips.no/fhir/R4/StructureDefinition/MustOccurBefore
Appointment.Slices for extension.extension:Department 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension
Appointment.Slices for extension.extension:Location 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension
Appointment.Slices for extension.extension:Section 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension
Appointment.Slices for extension.extension:ward 0..* Reference() Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension
Appointment.Slices for extension.extension:ContactType 0..* CodeableConcept Extension
URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension
Appointment.Slices for extension.extension:LevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension
Appointment.Slices for extension.extension:NprLevelOfCare 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension
Appointment.Slices for extension.extension:Termination 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension
Appointment.Slices for extension.extension:Reminder 0..* boolean Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/Reminder
Appointment.Slices for extension.extension:DiagnoseGroup 0..* CodeableConcept Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension
Appointment.Slices for extension.extension:VideoUrl 0..* string Optional Extensions Element
URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl
Appointment.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Appointment.Slices for identifier This element is included in summaries. 2..2 Identifier External Ids for this item
Slice: Unordered, Open by value:system
Appointment.Slices for identifier.identifier:DIPSPlannedContactId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.id 0..1 string Unique id for inter-element referencing
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.system This element is included in summaries. 1..1 uri DIPS: OID for planned contact id
Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSPlannedContactId.value This element is included in summaries. 1..1 string DIPS: planned contact id
Example General: 123456
Appointment.Slices for identifier.identifier:DIPSBookingId This element is included in summaries. 1..1 Identifier External Ids for this item
Appointment.Slices for identifier.identifier:DIPSBookingId.id 0..1 string Unique id for inter-element referencing
Appointment.Slices for identifier.identifier:DIPSBookingId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.Slices for identifier.identifier:DIPSBookingId.system This element is included in summaries. 1..1 uri DIPS: OID for bookingId
Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid (no extensions allowed)
Appointment.Slices for identifier.identifier:DIPSBookingId.value This element is included in summaries. 1..1 string DIPS: booking id
Example General: 123456
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow)
Binding: AppointmentStatus (required)
Appointment.start This element is included in summaries. 1..1 instant DIPS: checkin time
Appointment.end This element is included in summaries. 0..1 instant When appointment is to conclude
Appointment.slot 0..* Reference(SelfBookingSlot) DIPS: one slot for each planned activity as a contained resource
Appointment.slot.id 0..1 string Unique id for inter-element referencing
Appointment.slot.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.slot.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.slot.display This element is included in summaries. 0..1 string Text alternative for the resource
Appointment.participant C 1..1 BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.id 0..1 string Unique id for inter-element referencing
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 even if unrecognized
Appointment.participant.actor This element is included in summaries. 0..1 Reference(DIPSSubjectReference) Person, Location/HealthcareService or Device
Appointment.participant.actor.id 0..1 string Unique id for inter-element referencing
Appointment.participant.actor.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.participant.actor.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Appointment.participant.actor.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Appointment.participant.actor.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Appointment.participant.actor.display This element is included in summaries. 0..1 string Text alternative for the resource
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
Appointment.participant.period 0..1 Period Participation period of the actor

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.status Base required AppointmentStatus 📦4.0.1 FHIR Std.
Appointment.participant.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 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.exists() = 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' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron