StructureDefinition: ehealth-appointmentresponse

Introduction

An AppointmentResponse is a response to an Appointment, such as a confirmation or rejection. In its most basic form, the AppointmentResponse contains a reference to the actual Appointment, the participant (actor), and a status indicating if the response indicates eg. a confirmation (participantStatus=accepted) or rejection (participantStatus=declined).

Scope and Usage

In the eHealth Infrastructure the AppointmentResponse resource is used in conjunction with the following resources:

Appointment
- The actual Appointment which the AppointmentResponse regards
Patient
- If the response is for a Patient that is a participant on the referenced Appointment
Practitioner
- If the response is for a Practitioner that is a participant on the referenced Appointment
RelatedPerson
- If the response is for a RelatedPerson that is a participant on the referenced Appointment
Location
- If the response is for a Location that is a participant on the referenced Appointment (eg. a meeting room that rejects an Appointment if it’s already occupied).

Formal Views of Profile Content

The official URL for this profile is:

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

This profile builds on AppointmentResponse.

This profile was published on Fri Jun 07 11:10:06 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 AppointmentResponse

Summary

Structures

This structure refers to these other structures:

This structure is derived from AppointmentResponse

Name	Card.	Type
AppointmentResponse	0..*
appointment	1..1	Reference(eHealth Appointment) {r }
actor	0..1	Reference(eHealth Patient \| eHealth Practitioner \| eHealth RelatedPerson \| Location) {r }
Documentation for this format

This structure is derived from AppointmentResponse

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	I	0..*		A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
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	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
appointment	Σ	1..1	Reference(eHealth Appointment) {r }	Appointment this response relates to
start		0..1	instant	Time from appointment, or requested new start time
end		0..1	instant	Time from appointment, or requested new end time
participantType	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible)
actor	Σ	0..1	Reference(eHealth Patient \| eHealth Practitioner \| eHealth RelatedPerson \| Location) {r }	Person, Location/HealthcareService or Device
participantStatus	?!Σ	1..1	code	accepted \| declined \| tentative \| in-process \| completed \| needs-action \| entered-in-error Binding: ParticipationStatus (required)
comment		0..1	string	Additional comments
Documentation for this format

This structure is derived from AppointmentResponse

Summary

Structures

This structure refers to these other structures:

Differential View

This structure is derived from AppointmentResponse

Name	Card.	Type
AppointmentResponse	0..*
appointment	1..1	Reference(eHealth Appointment) {r }
actor	0..1	Reference(eHealth Patient \| eHealth Practitioner \| eHealth RelatedPerson \| Location) {r }
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	I	0..*		A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
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	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
appointment	Σ	1..1	Reference(eHealth Appointment) {r }	Appointment this response relates to
start		0..1	instant	Time from appointment, or requested new start time
end		0..1	instant	Time from appointment, or requested new end time
participantType	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible)
actor	Σ	0..1	Reference(eHealth Patient \| eHealth Practitioner \| eHealth RelatedPerson \| Location) {r }	Person, Location/HealthcareService or Device
participantStatus	?!Σ	1..1	code	accepted \| declined \| tentative \| in-process \| completed \| needs-action \| entered-in-error Binding: ParticipationStatus (required)
comment		0..1	string	Additional comments
Documentation for this format

Terminology Bindings

Path	Name	Conformance	ValueSet
AppointmentResponse.language	Common Languages	extensible	Common Languages
AppointmentResponse.participantType	ParticipantType	extensible	ParticipantType
AppointmentResponse.participantStatus	ParticipationStatus	required	ParticipationStatus

Constraints

Id	Path	Details	Requirements
dom-2	AppointmentResponse	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-1	AppointmentResponse	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-4	AppointmentResponse	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	AppointmentResponse	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()
apr-1	AppointmentResponse	Either the participantType or actor must be specified : participantType.exists() or actor.exists()