Extra Validation Constraints

• When a dateTime value is present in the ehealth-registration-deadline extension, then a WARNING validation issue will be raised if a participant is added to the appointment after this point in time
  • This constraint is implemented directly on the server due to technical limitations, which means it is not listed with other Implementation Guide constraints
• The ehealth-creator extension value is managed by the server and holds a reference to the CareTeam that created the group appointment
  • When creating a new group appointment, the server automatically fills out this value based on the JWT CareTeam context of the user
  • Trying to assign a value different from the CareTeam in context when creating a group appointment, or changing this value in an update or patch operation, generates a http 422 error
  • The value is used by the security system of the server to allow the original creator of the group appointment to modify the appointment after creation, even when the creator is not the ehealth-responsible party

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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, responsible-1, max-participants, min-participants
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:endMeetingOnEndTime		0..1	boolean	Indicates if a video meeting must end on end time URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
extension:maxParticipants		0..1	integer	The maximum number of participants allowed to participate in a video meeting URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
extension:meetingUrl		0..1	uri	Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
extension:vmrUri		0..1	uri	Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
extension:guestPinCode		0..1	string	Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
extension:hostPinCode		0..1	string	Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
extension:responsible		1..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
extension:groupId		0..1	string	Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
extension:legalBasis	C	0..1	CodeableConcept	Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2
extension:releasableResource		0..1	boolean	Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
extension:responsibleOrganization		0..1	Reference(ehealth-organization) {r}	Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
extension:performer		0..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
extension:creator		0..1	Reference(ehealth-careteam) {r}	Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
extension:intendedAudience		0..*	Reference(ehealth-organization) {r}	The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
extension:registrationDeadline		0..1	dateTime	Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
extension:performingOrganization		0..1	Reference(ehealth-organization) {r}	Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
Slices for serviceType	Σ	1..*	CodeableConcept	The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example)
serviceType:appointmentServiceType	Σ	1..1	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: Appointment Service Type (required)
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: group-video
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required)
reasonCode	Σ	0..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Appointment Reason (required)
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..1	Reference(ehealth-episodeofcare | ehealth-careplan) {r}	Additional information to support the appointment
start	Σ	1..1	instant	When appointment is to take place
end	Σ	1..1	instant	When appointment is to conclude
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careteam		0..1	Reference(ehealth-careteam) {r}	Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
extension:assigningCareteam		0..1	Reference()	Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c}	Person, Location/HealthcareService or Device
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType.​coding	Base	required	Appointment Service Type	📦3.6.0	This IG
Appointment.appointmentType	Base	required	Appointment Type Codes	📦3.6.0	This IG
Appointment.reasonCode	Base	required	Appointment Reason	📦3.6.0	This IG
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()
governance-1	error	Appointment.extension:legalBasis	When extension is used a Episode of Care MUST be referenced	%resource.supportingInformation.reference.contains('EpisodeOfCare/')
max-participants	warning	Appointment	Too many intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participants	warning	Appointment	Too few intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
responsible-1	error	Appointment	Ensuring that responsible entity is a participating party	(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
responsible-2	error	Appointment.extension:legalBasis	Both performing organization and responsible organization must be populated when legal basis is used	%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: responsible-1, max-participants, min-participants
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:endMeetingOnEndTime		0..1	boolean	Indicates if a video meeting must end on end time URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
extension:maxParticipants		0..1	integer	The maximum number of participants allowed to participate in a video meeting URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
extension:meetingUrl		0..1	uri	Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
extension:vmrUri		0..1	uri	Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
extension:guestPinCode		0..1	string	Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
extension:hostPinCode		0..1	string	Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
extension:responsible		1..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
extension:groupId		0..1	string	Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
extension:legalBasis	C	0..1	CodeableConcept	Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2
extension:releasableResource		0..1	boolean	Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
extension:responsibleOrganization		0..1	Reference(ehealth-organization) {r}	Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
extension:performer		0..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
extension:creator		0..1	Reference(ehealth-careteam) {r}	Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
extension:intendedAudience		0..*	Reference(ehealth-organization) {r}	The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
extension:registrationDeadline		0..1	dateTime	Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
extension:performingOrganization		0..1	Reference(ehealth-organization) {r}	Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
Slices for serviceType		1..*	CodeableConcept	The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code
serviceType:appointmentServiceType		1..1	CodeableConcept	The specific service that is to be performed during this appointment
coding		0..*	Coding	Code defined by a terminology system Binding: Appointment Service Type (required)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: group-video
appointmentType		1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required)
reasonCode		0..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Appointment Reason (required)
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..1	Reference(ehealth-episodeofcare | ehealth-careplan) {r}	Additional information to support the appointment
start		1..1	instant	When appointment is to take place
end		1..1	instant	When appointment is to conclude
participant
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careteam		0..1	Reference(ehealth-careteam) {r}	Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
extension:assigningCareteam		0..1	Reference()	Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
actor		0..1	Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c}	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.serviceType:appointmentServiceType.​coding	Base	required	Appointment Service Type	📦3.6.0	This IG
Appointment.appointmentType	Base	required	Appointment Type Codes	📦3.6.0	This IG
Appointment.reasonCode	Base	required	Appointment Reason	📦3.6.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
governance-1	error	Appointment.extension:legalBasis	When extension is used a Episode of Care MUST be referenced	%resource.supportingInformation.reference.contains('EpisodeOfCare/')
max-participants	warning	Appointment	Too many intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participants	warning	Appointment	Too few intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
responsible-1	error	Appointment	Ensuring that responsible entity is a participating party	(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
responsible-2	error	Appointment.extension:legalBasis	Both performing organization and responsible organization must be populated when legal basis is used	%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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, responsible-1, max-participants, min-participants
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:endMeetingOnEndTime		0..1	boolean	Indicates if a video meeting must end on end time URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
extension:maxParticipants		0..1	integer	The maximum number of participants allowed to participate in a video meeting URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
extension:meetingUrl		0..1	uri	Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
extension:vmrUri		0..1	uri	Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
extension:guestPinCode		0..1	string	Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
extension:hostPinCode		0..1	string	Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
extension:responsible		1..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
extension:groupId		0..1	string	Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
extension:legalBasis	C	0..1	CodeableConcept	Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2
extension:releasableResource		0..1	boolean	Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
extension:responsibleOrganization		0..1	Reference(ehealth-organization) {r}	Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
extension:performer		0..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
extension:creator		0..1	Reference(ehealth-careteam) {r}	Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
extension:intendedAudience		0..*	Reference(ehealth-organization) {r}	The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
extension:registrationDeadline		0..1	dateTime	Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
extension:performingOrganization		0..1	Reference(ehealth-organization) {r}	Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
Slices for serviceType	Σ	1..*	CodeableConcept	The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example)
serviceType:appointmentServiceType	Σ	1..1	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: Appointment Service Type (required)
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: group-video
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required)
reasonCode	Σ	0..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Appointment Reason (required)
reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..1	Reference(ehealth-episodeofcare | ehealth-careplan) {r}	Additional information to support the appointment
start	Σ	1..1	instant	When appointment is to take place
end	Σ	1..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careteam		0..1	Reference(ehealth-careteam) {r}	Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
extension:assigningCareteam		0..1	Reference()	Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c}	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.cancelationReason	Base	example	Appointment cancellation reason	📍4.0.1	FHIR Std.
Appointment.serviceCategory	Base	example	Service category	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType.​coding	Base	required	Appointment Service Type	📦3.6.0	This IG
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.0.1	FHIR Std.
Appointment.appointmentType	Base	required	Appointment Type Codes	📦3.6.0	This IG
Appointment.reasonCode	Base	required	Appointment Reason	📦3.6.0	This IG
Appointment.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍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()
governance-1	error	Appointment.extension:legalBasis	When extension is used a Episode of Care MUST be referenced	%resource.supportingInformation.reference.contains('EpisodeOfCare/')
max-participants	warning	Appointment	Too many intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participants	warning	Appointment	Too few intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
responsible-1	error	Appointment	Ensuring that responsible entity is a participating party	(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
responsible-2	error	Appointment.extension:legalBasis	Both performing organization and responsible organization must be populated when legal basis is used	%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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, responsible-1, max-participants, min-participants
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:endMeetingOnEndTime		0..1	boolean	Indicates if a video meeting must end on end time URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
extension:maxParticipants		0..1	integer	The maximum number of participants allowed to participate in a video meeting URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
extension:meetingUrl		0..1	uri	Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
extension:vmrUri		0..1	uri	Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
extension:guestPinCode		0..1	string	Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
extension:hostPinCode		0..1	string	Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
extension:responsible		1..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
extension:groupId		0..1	string	Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
extension:legalBasis	C	0..1	CodeableConcept	Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2
extension:releasableResource		0..1	boolean	Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
extension:responsibleOrganization		0..1	Reference(ehealth-organization) {r}	Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
extension:performer		0..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
extension:creator		0..1	Reference(ehealth-careteam) {r}	Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
extension:intendedAudience		0..*	Reference(ehealth-organization) {r}	The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
extension:registrationDeadline		0..1	dateTime	Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
extension:performingOrganization		0..1	Reference(ehealth-organization) {r}	Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
Slices for serviceType	Σ	1..*	CodeableConcept	The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example)
serviceType:appointmentServiceType	Σ	1..1	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: Appointment Service Type (required)
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: group-video
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required)
reasonCode	Σ	0..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Appointment Reason (required)
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..1	Reference(ehealth-episodeofcare | ehealth-careplan) {r}	Additional information to support the appointment
start	Σ	1..1	instant	When appointment is to take place
end	Σ	1..1	instant	When appointment is to conclude
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careteam		0..1	Reference(ehealth-careteam) {r}	Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
extension:assigningCareteam		0..1	Reference()	Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c}	Person, Location/HealthcareService or Device
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType.​coding	Base	required	Appointment Service Type	📦3.6.0	This IG
Appointment.appointmentType	Base	required	Appointment Type Codes	📦3.6.0	This IG
Appointment.reasonCode	Base	required	Appointment Reason	📦3.6.0	This IG
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()
governance-1	error	Appointment.extension:legalBasis	When extension is used a Episode of Care MUST be referenced	%resource.supportingInformation.reference.contains('EpisodeOfCare/')
max-participants	warning	Appointment	Too many intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participants	warning	Appointment	Too few intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
responsible-1	error	Appointment	Ensuring that responsible entity is a participating party	(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
responsible-2	error	Appointment.extension:legalBasis	Both performing organization and responsible organization must be populated when legal basis is used	%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()

Differential View

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: responsible-1, max-participants, min-participants
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:endMeetingOnEndTime		0..1	boolean	Indicates if a video meeting must end on end time URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
extension:maxParticipants		0..1	integer	The maximum number of participants allowed to participate in a video meeting URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
extension:meetingUrl		0..1	uri	Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
extension:vmrUri		0..1	uri	Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
extension:guestPinCode		0..1	string	Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
extension:hostPinCode		0..1	string	Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
extension:responsible		1..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
extension:groupId		0..1	string	Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
extension:legalBasis	C	0..1	CodeableConcept	Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2
extension:releasableResource		0..1	boolean	Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
extension:responsibleOrganization		0..1	Reference(ehealth-organization) {r}	Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
extension:performer		0..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
extension:creator		0..1	Reference(ehealth-careteam) {r}	Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
extension:intendedAudience		0..*	Reference(ehealth-organization) {r}	The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
extension:registrationDeadline		0..1	dateTime	Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
extension:performingOrganization		0..1	Reference(ehealth-organization) {r}	Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
Slices for serviceType		1..*	CodeableConcept	The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code
serviceType:appointmentServiceType		1..1	CodeableConcept	The specific service that is to be performed during this appointment
coding		0..*	Coding	Code defined by a terminology system Binding: Appointment Service Type (required)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: group-video
appointmentType		1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required)
reasonCode		0..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Appointment Reason (required)
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..1	Reference(ehealth-episodeofcare | ehealth-careplan) {r}	Additional information to support the appointment
start		1..1	instant	When appointment is to take place
end		1..1	instant	When appointment is to conclude
participant
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careteam		0..1	Reference(ehealth-careteam) {r}	Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
extension:assigningCareteam		0..1	Reference()	Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
actor		0..1	Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c}	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.serviceType:appointmentServiceType.​coding	Base	required	Appointment Service Type	📦3.6.0	This IG
Appointment.appointmentType	Base	required	Appointment Type Codes	📦3.6.0	This IG
Appointment.reasonCode	Base	required	Appointment Reason	📦3.6.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
governance-1	error	Appointment.extension:legalBasis	When extension is used a Episode of Care MUST be referenced	%resource.supportingInformation.reference.contains('EpisodeOfCare/')
max-participants	warning	Appointment	Too many intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participants	warning	Appointment	Too few intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
responsible-1	error	Appointment	Ensuring that responsible entity is a participating party	(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
responsible-2	error	Appointment.extension:legalBasis	Both performing organization and responsible organization must be populated when legal basis is used	%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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, responsible-1, max-participants, min-participants
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:endMeetingOnEndTime		0..1	boolean	Indicates if a video meeting must end on end time URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
extension:maxParticipants		0..1	integer	The maximum number of participants allowed to participate in a video meeting URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
extension:meetingUrl		0..1	uri	Meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
extension:vmrUri		0..1	uri	Video meeting URL URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
extension:guestPinCode		0..1	string	Guest PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
extension:hostPinCode		0..1	string	Host PIN code URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
extension:responsible		1..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Responsible careteam/practitioner URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
extension:groupId		0..1	string	Logical id identifying a set of messages with the same recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
extension:legalBasis	C	0..1	CodeableConcept	Legal basis URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis Binding: Jurisdiction (required) Constraints: governance-1, responsible-2
extension:releasableResource		0..1	boolean	Indicates if the resource may be shared through national document repositories URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
extension:responsibleOrganization		0..1	Reference(ehealth-organization) {r}	Responsible organization URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
extension:performer		0..1	Reference(ehealth-careteam | ehealth-practitioner) {r}	Performer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
extension:creator		0..1	Reference(ehealth-careteam) {r}	Creator Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
extension:intendedAudience		0..*	Reference(ehealth-organization) {r}	The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
extension:registrationDeadline		0..1	dateTime	Registration deadline URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
extension:performingOrganization		0..1	Reference(ehealth-organization) {r}	Organization who is performing in the given context URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
Slices for serviceType	Σ	1..*	CodeableConcept	The specific service that is to be performed during this appointment Slice: Unordered, Open by value:coding.code Binding: ServiceType (example)
serviceType:appointmentServiceType	Σ	1..1	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: Appointment Service Type (required)
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: group-video
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (required)
reasonCode	Σ	0..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Appointment Reason (required)
reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..1	Reference(ehealth-episodeofcare | ehealth-careplan) {r}	Additional information to support the appointment
start	Σ	1..1	instant	When appointment is to take place
end	Σ	1..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careteam		0..1	Reference(ehealth-careteam) {r}	Careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
extension:assigningCareteam		0..1	Reference()	Assigning careteam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {r, c}	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.cancelationReason	Base	example	Appointment cancellation reason	📍4.0.1	FHIR Std.
Appointment.serviceCategory	Base	example	Service category	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType	Base	example	Service type	📍4.0.1	FHIR Std.
Appointment.serviceType:appointmentServiceType.​coding	Base	required	Appointment Service Type	📦3.6.0	This IG
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.0.1	FHIR Std.
Appointment.appointmentType	Base	required	Appointment Type Codes	📦3.6.0	This IG
Appointment.reasonCode	Base	required	Appointment Reason	📦3.6.0	This IG
Appointment.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍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()
governance-1	error	Appointment.extension:legalBasis	When extension is used a Episode of Care MUST be referenced	%resource.supportingInformation.reference.contains('EpisodeOfCare/')
max-participants	warning	Appointment	Too many intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participants	warning	Appointment	Too few intended participants	extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
responsible-1	error	Appointment	Ensuring that responsible entity is a participating party	(extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
responsible-2	error	Appointment.extension:legalBasis	Both performing organization and responsible organization must be populated when legal basis is used	%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()

This structure is derived from Appointment

Summary

Mandatory: 8 elements(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

• ehealth-episodeofcare (http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare)
• ehealth-careplan (http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan)
• ehealth-patient (http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient)
• ehealth-practitioner (http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioner)
• ehealth-relatedperson (http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-relatedperson)

Extensions

This structure refers to these extensions:

• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
• http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Appointment.serviceType