DIPS Core Implementation Guide
0.1.0 - ci-build
Norway
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
| Official URL: http://dips.no/fhir/R4/StructureDefinition/DIPSAppointment | Version: 0.1.0 | |||
| Draft as of 2026-09-03 | Computable Name: DIPSAppointment | |||
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   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 | |
| extension:Department |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension | |
| extension:Location |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension | |
| extension:Section |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension | |
| extension:ward |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension | |
| extension:ContactType |
0..* | CodeableConcept | Extension URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension | |
| extension:LevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension | |
| extension:NprLevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension | |
| extension:Termination |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension | |
| extension:Reminder |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/Reminder | |
| extension:DiagnoseGroup |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension | |
 extension:VideoUrl |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier |
Σ | 2..2 | Identifier | External Ids for this item Slice: Unordered, Open by value:system |
 identifier:DIPSPlannedContactId |
Σ | 1..1 | Identifier | External Ids for this item |
  system |
Σ | 1..1 | uri | DIPS: OID for planned contact id Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid |
 value |
Σ | 1..1 | string | DIPS: planned contact id Example General: 123456 |
 identifier:DIPSBookingId |
Σ | 1..1 | Identifier | External Ids for this item |
 system |
Σ | 1..1 | uri | DIPS: OID for bookingId Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid |
| value |
Σ | 1..1 | string | DIPS: booking id Example General: 123456 |
| status |
?!Σ | 1..1 | code | DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow) Binding: AppointmentStatus (required) |
| start |
Σ | 1..1 | instant | DIPS: checkin time |
 slot |
0..* | Reference(SelfBookingSlot) | DIPS: one slot for each planned activity as a contained resource | |
 reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
  participant |
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
Σ | 0..1 | Reference(DIPSSubjectReference) | Person, Location/HealthcareService or Device |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) |
| Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| extension:Department |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension | |
| extension:Location |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension | |
| extension:Section |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension | |
| extension:ward |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension | |
| extension:ContactType |
0..* | CodeableConcept | Extension URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension | |
| extension:LevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension | |
| extension:NprLevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension | |
| extension:Termination |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension | |
| extension:Reminder |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/Reminder | |
| extension:DiagnoseGroup |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension | |
| extension:VideoUrl |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl | |
| Slices for identifier |
2..2 | Identifier | External Ids for this item Slice: Unordered, Open by value:system | |
| identifier:DIPSPlannedContactId |
1..1 | Identifier | External Ids for this item | |
 use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | DIPS: OID for planned contact id Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid | |
| value |
1..1 | string | DIPS: planned contact id | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| identifier:DIPSBookingId |
1..1 | Identifier | External Ids for this item | |
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | DIPS: OID for bookingId Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid | |
| value |
1..1 | string | DIPS: booking id | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| status |
1..1 | code | DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow) Binding: AppointmentStatus (required) | |
| cancelationReason |
0..0 | The coded reason for the appointment being cancelled | ||
| serviceCategory |
0..0 | A broad categorization of the service that is to be performed during this appointment | ||
| serviceType |
0..0 | The specific service that is to be performed during this appointment | ||
| specialty |
0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||
| appointmentType |
0..0 | The style of appointment or patient that has been booked in the slot (not service type) | ||
| reasonCode |
0..0 | Coded reason this appointment is scheduled | ||
| reasonReference |
0..0 | Reason the appointment is to take place (resource) | ||
| priority |
0..0 | Used to make informed decisions if needing to re-prioritize | ||
| description |
0..0 | Shown on a subject line in a meeting request, or appointment list | ||
| supportingInformation |
0..0 | Additional information to support the appointment | ||
| start |
1..1 | instant | DIPS: checkin time | |
| minutesDuration |
0..0 | Can be less than start/end (e.g. estimate) | ||
| slot |
0..* | Reference(SelfBookingSlot) | DIPS: one slot for each planned activity as a contained resource | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| created |
0..0 | The date that this appointment was initially created | ||
| comment |
0..0 | Additional comments | ||
| patientInstruction |
0..0 | Detailed information and instructions for the patient | ||
| basedOn |
0..0 | The service request this appointment is allocated to assess | ||
| participant |
1..1 | BackboneElement | Participants involved in appointment | |
| type |
0..0 | Role of participant in the appointment | ||
| actor |
0..1 | Reference(DIPSSubjectReference) | Person, Location/HealthcareService or Device | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) | |
| requestedPeriod |
0..0 | Potential date/time interval(s) requested to allocate the appointment within | ||
| Documentation for this format | ||||
| 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. |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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: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 | |||||
| extension:Department |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension | |||||
| extension:Location |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension | |||||
| extension:Section |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension | |||||
| extension:ward |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension | |||||
| extension:ContactType |
0..* | CodeableConcept | Extension URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension | |||||
| extension:LevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension | |||||
| extension:NprLevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension | |||||
| extension:Termination |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension | |||||
| extension:Reminder |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/Reminder | |||||
| extension:DiagnoseGroup |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension | |||||
| extension:VideoUrl |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 2..2 | Identifier | External Ids for this item Slice: Unordered, Open by value:system | ||||
| identifier:DIPSPlannedContactId |
Σ | 1..1 | Identifier | External Ids for this item | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | DIPS: OID for planned contact id Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid | ||||
| value |
Σ | 1..1 | string | DIPS: planned contact id Example General: 123456 | ||||
| identifier:DIPSBookingId |
Σ | 1..1 | Identifier | External Ids for this item | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | DIPS: OID for bookingId Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid | ||||
| value |
Σ | 1..1 | string | DIPS: booking id Example General: 123456 | ||||
| status |
?!Σ | 1..1 | code | DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow) Binding: AppointmentStatus (required) | ||||
| start |
Σ | 1..1 | instant | DIPS: checkin time | ||||
| end |
Σ | 0..1 | instant | When appointment is to conclude | ||||
| slot |
0..* | Reference(SelfBookingSlot) | DIPS: one slot for each planned activity as a contained resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| participant |
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actor |
Σ | 0..1 | Reference(DIPSSubjectReference) | Person, Location/HealthcareService or Device | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 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). | ||||
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| Documentation for this format | ||||||||
| 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. |
| 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
Summary
Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 2 elements
Prohibited: 28 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| extension:Department |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension | |
| extension:Location |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension | |
| extension:Section |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension | |
| extension:ward |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension | |
| extension:ContactType |
0..* | CodeableConcept | Extension URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension | |
| extension:LevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension | |
| extension:NprLevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension | |
| extension:Termination |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension | |
| extension:Reminder |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/Reminder | |
| extension:DiagnoseGroup |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension | |
| extension:VideoUrl |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 2..2 | Identifier | External Ids for this item Slice: Unordered, Open by value:system |
| identifier:DIPSPlannedContactId |
Σ | 1..1 | Identifier | External Ids for this item |
| system |
Σ | 1..1 | uri | DIPS: OID for planned contact id Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid |
| value |
Σ | 1..1 | string | DIPS: planned contact id Example General: 123456 |
| identifier:DIPSBookingId |
Σ | 1..1 | Identifier | External Ids for this item |
| system |
Σ | 1..1 | uri | DIPS: OID for bookingId Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid |
| value |
Σ | 1..1 | string | DIPS: booking id Example General: 123456 |
| status |
?!Σ | 1..1 | code | DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow) Binding: AppointmentStatus (required) |
| start |
Σ | 1..1 | instant | DIPS: checkin time |
| slot |
0..* | Reference(SelfBookingSlot) | DIPS: one slot for each planned activity as a contained resource | |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| participant |
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
Σ | 0..1 | Reference(DIPSSubjectReference) | Person, Location/HealthcareService or Device |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) |
| Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | |
| extension:Department |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension | |
| extension:Location |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension | |
| extension:Section |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension | |
| extension:ward |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension | |
| extension:ContactType |
0..* | CodeableConcept | Extension URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension | |
| extension:LevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension | |
| extension:NprLevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension | |
| extension:Termination |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension | |
| extension:Reminder |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/Reminder | |
| extension:DiagnoseGroup |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension | |
| extension:VideoUrl |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl | |
| Slices for identifier |
2..2 | Identifier | External Ids for this item Slice: Unordered, Open by value:system | |
| identifier:DIPSPlannedContactId |
1..1 | Identifier | External Ids for this item | |
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | DIPS: OID for planned contact id Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid | |
| value |
1..1 | string | DIPS: planned contact id | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| identifier:DIPSBookingId |
1..1 | Identifier | External Ids for this item | |
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | DIPS: OID for bookingId Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid | |
| value |
1..1 | string | DIPS: booking id | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| status |
1..1 | code | DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow) Binding: AppointmentStatus (required) | |
| cancelationReason |
0..0 | The coded reason for the appointment being cancelled | ||
| serviceCategory |
0..0 | A broad categorization of the service that is to be performed during this appointment | ||
| serviceType |
0..0 | The specific service that is to be performed during this appointment | ||
| specialty |
0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||
| appointmentType |
0..0 | The style of appointment or patient that has been booked in the slot (not service type) | ||
| reasonCode |
0..0 | Coded reason this appointment is scheduled | ||
| reasonReference |
0..0 | Reason the appointment is to take place (resource) | ||
| priority |
0..0 | Used to make informed decisions if needing to re-prioritize | ||
| description |
0..0 | Shown on a subject line in a meeting request, or appointment list | ||
| supportingInformation |
0..0 | Additional information to support the appointment | ||
| start |
1..1 | instant | DIPS: checkin time | |
| minutesDuration |
0..0 | Can be less than start/end (e.g. estimate) | ||
| slot |
0..* | Reference(SelfBookingSlot) | DIPS: one slot for each planned activity as a contained resource | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| created |
0..0 | The date that this appointment was initially created | ||
| comment |
0..0 | Additional comments | ||
| patientInstruction |
0..0 | Detailed information and instructions for the patient | ||
| basedOn |
0..0 | The service request this appointment is allocated to assess | ||
| participant |
1..1 | BackboneElement | Participants involved in appointment | |
| type |
0..0 | Role of participant in the appointment | ||
| actor |
0..1 | Reference(DIPSSubjectReference) | Person, Location/HealthcareService or Device | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) | |
| requestedPeriod |
0..0 | Potential date/time interval(s) requested to allocate the appointment within | ||
| Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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: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 | |||||
| extension:Department |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DepartmentExtension | |||||
| extension:Location |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LocationExtension | |||||
| extension:Section |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/SectionExtension | |||||
| extension:ward |
0..* | Reference() | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/WardExtension | |||||
| extension:ContactType |
0..* | CodeableConcept | Extension URL: http://dips.no/fhir/R4/StructureDefinition/ContactTypeExtension | |||||
| extension:LevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/LevelOfCareExtension | |||||
| extension:NprLevelOfCare |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/NprLevelOfCareExtension | |||||
| extension:Termination |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/TerminationExtension | |||||
| extension:Reminder |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/Reminder | |||||
| extension:DiagnoseGroup |
0..* | CodeableConcept | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/DiagnoseGroupExtension | |||||
| extension:VideoUrl |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/R4/StructureDefinition/VideoUrl | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 2..2 | Identifier | External Ids for this item Slice: Unordered, Open by value:system | ||||
| identifier:DIPSPlannedContactId |
Σ | 1..1 | Identifier | External Ids for this item | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | DIPS: OID for planned contact id Fixed Value: http://dips.no/fhir/namingsystem/dips-plannedcontactid | ||||
| value |
Σ | 1..1 | string | DIPS: planned contact id Example General: 123456 | ||||
| identifier:DIPSBookingId |
Σ | 1..1 | Identifier | External Ids for this item | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | DIPS: OID for bookingId Fixed Value: http://dips.no/fhir/namingsystem/dips-bookingid | ||||
| value |
Σ | 1..1 | string | DIPS: booking id Example General: 123456 | ||||
| status |
?!Σ | 1..1 | code | DIPS: always 'booked' (proposed | pending | booked | arrived | fulfilled | cancelled | noshow) Binding: AppointmentStatus (required) | ||||
| start |
Σ | 1..1 | instant | DIPS: checkin time | ||||
| end |
Σ | 0..1 | instant | When appointment is to conclude | ||||
| slot |
0..* | Reference(SelfBookingSlot) | DIPS: one slot for each planned activity as a contained resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| participant |
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actor |
Σ | 0..1 | Reference(DIPSSubjectReference) | Person, Location/HealthcareService or Device | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 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). | ||||
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| Documentation for this format | ||||||||
| 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. |
| 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
Summary
Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 2 elements
Prohibited: 28 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron