Profile: ehealth-appointment

StructureDefinition: ehealth-appointment

Formal Views of Profile Content

The official URL for this profile is:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment

This profile uses multiple slices for the field participant. The slicing means that at least one patient, one location and at least one practitioner must be present. For more info on slicing, see the FHIR documentation.

This profile builds on Appointment.

This profile was published on Thu May 16 12:32:10 UTC 2019 as a draft by ehealth.sundhed.dk.

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

This structure is derived from Appointment

Summary

Mandatory: 6 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible

Slices

This structure defines the following Slices:

The element Appointment.participant is sliced based on the value of type:actor.reference

This structure is derived from Appointment

Name	Card.	Type	Description & Constraints
Appointment	0..*		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).
extension	0..*	Extension	Slice: Unordered, Open by value:url
ehealth-responsible	1..1	(Complex)	Individuals, careteam and/or organization responsible for monitoring this plan. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
appointmentType	1..1	CodeableConcept	Binding: AppointmentTypeCodes (extensible)
reason	1..*	CodeableConcept
participant		BackboneElement	Slice: Unordered, Open by type:actor.reference
participant	1..*	BackboneElement
type	0..0
actor	1..1	Reference(eHealth Patient)
required	1..1	code
participant	1..1	BackboneElement
type	0..0
actor	0..1	Reference(Location)
participant	1..*	BackboneElement
type	0..0
actor	0..1	Reference(eHealth Practitioner)
participant	1..*	BackboneElement
type	0..0
actor	0..1	Reference(eHealth RelatedPerson)
Documentation for this format

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
Appointment	I	0..*		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).
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ehealth-responsible		1..1	(Complex)	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error Binding: AppointmentStatus (required)
serviceCategory	Σ	0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Practice Setting Code Value Set (preferred)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: AppointmentTypeCodes (extensible)
reason	Σ	1..*	CodeableConcept	Reason this appointment is scheduled Binding: Encounter Reason Codes (preferred)
indication		0..*	Reference(Condition \| Procedure)	Reason the appointment is to takes place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
start	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
incomingReferral		0..*	Reference(ReferralRequest)	The ReferralRequest provided as information to allocate to the Encounter
participant	I		BackboneElement	Participants involved in appointment Slice: Unordered, Open by type:actor.reference
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible)
actor	Σ	0..1	Reference(Patient \| Practitioner \| RelatedPerson \| Device \| HealthcareService \| Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	1..1	Reference(eHealth Patient)	Person, Location/HealthcareService or Device
required	Σ	1..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..1	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	0..1	Reference(eHealth Practitioner)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	0..1	Reference(eHealth RelatedPerson)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

This structure is derived from Appointment

Summary

Mandatory: 6 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible

Slices

This structure defines the following Slices:

The element Appointment.participant is sliced based on the value of type:actor.reference

Differential View

This structure is derived from Appointment

Name	Card.	Type	Description & Constraints
Appointment	0..*		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).
extension	0..*	Extension	Slice: Unordered, Open by value:url
ehealth-responsible	1..1	(Complex)	Individuals, careteam and/or organization responsible for monitoring this plan. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
appointmentType	1..1	CodeableConcept	Binding: AppointmentTypeCodes (extensible)
reason	1..*	CodeableConcept
participant		BackboneElement	Slice: Unordered, Open by type:actor.reference
participant	1..*	BackboneElement
type	0..0
actor	1..1	Reference(eHealth Patient)
required	1..1	code
participant	1..1	BackboneElement
type	0..0
actor	0..1	Reference(Location)
participant	1..*	BackboneElement
type	0..0
actor	0..1	Reference(eHealth Practitioner)
participant	1..*	BackboneElement
type	0..0
actor	0..1	Reference(eHealth RelatedPerson)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Appointment	I	0..*		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).
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ehealth-responsible		1..1	(Complex)	Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error Binding: AppointmentStatus (required)
serviceCategory	Σ	0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Practice Setting Code Value Set (preferred)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: AppointmentTypeCodes (extensible)
reason	Σ	1..*	CodeableConcept	Reason this appointment is scheduled Binding: Encounter Reason Codes (preferred)
indication		0..*	Reference(Condition \| Procedure)	Reason the appointment is to takes place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
start	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
incomingReferral		0..*	Reference(ReferralRequest)	The ReferralRequest provided as information to allocate to the Encounter
participant	I		BackboneElement	Participants involved in appointment Slice: Unordered, Open by type:actor.reference
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible)
actor	Σ	0..1	Reference(Patient \| Practitioner \| RelatedPerson \| Device \| HealthcareService \| Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	1..1	Reference(eHealth Patient)	Person, Location/HealthcareService or Device
required	Σ	1..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..1	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	0..1	Reference(eHealth Practitioner)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
participant	I	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor	Σ	0..1	Reference(eHealth RelatedPerson)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only Binding: ParticipantRequired (required)
status		1..1	code	accepted \| declined \| tentative \| needs-action Binding: ParticipationStatus (required)
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Name	Conformance	ValueSet
Appointment.language	Common Languages	extensible	Common Languages
Appointment.status	AppointmentStatus	required	AppointmentStatus
Appointment.serviceCategory	ServiceCategory	example	ServiceCategory
Appointment.serviceType	ServiceType	example	ServiceType
Appointment.specialty	Practice Setting Code Value Set	preferred	Practice Setting Code Value Set
Appointment.appointmentType	AppointmentTypeCodes	extensible	AppointmentTypeCodes
Appointment.reason	Encounter Reason Codes	preferred	Encounter Reason Codes
Appointment.participant.type	ParticipantType	extensible	ParticipantType
Appointment.participant.required	ParticipantRequired	required	ParticipantRequired
Appointment.participant.status	ParticipationStatus	required	ParticipationStatus
Appointment.participant.required	ParticipantRequired	required	ParticipantRequired
Appointment.participant.status	ParticipationStatus	required	ParticipationStatus
Appointment.participant.required	ParticipantRequired	required	ParticipantRequired
Appointment.participant.status	ParticipationStatus	required	ParticipationStatus
Appointment.participant.required	ParticipantRequired	required	ParticipantRequired
Appointment.participant.status	ParticipationStatus	required	ParticipationStatus
Appointment.participant.required	ParticipantRequired	required	ParticipantRequired
Appointment.participant.status	ParticipationStatus	required	ParticipationStatus

Constraints

Id	Path	Details	Requirements
dom-2	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-1	Appointment	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-4	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-3	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
app-3	Appointment	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' \| 'cancelled'))
app-2	Appointment	Either start and end are specified, or neither : start.empty() xor end.exists()
ele-1	Appointment.participant	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
app-1	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
ele-1	Appointment.participant	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
app-1	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
ele-1	Appointment.participant	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
app-1	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
ele-1	Appointment.participant	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
app-1	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
ele-1	Appointment.participant	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
app-1	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()