eHealth Infrastructure (v2019.5.3)

StructureDefinition: ehealth-appointment

Introduction

An Appointment is a booking of a healthcare event among ehealth patients, practitioners, related persons, and locations. This may be either a virtual or physical meeting. Even though a meeting may span a number of participants, only one physical Appointment resource must be created. Participant status (approved, declined etc.) is handled using the AppointmentResponse resource.

Scope and Usage

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

  • Patient
    • If the appointment contains a participant of type Patient
  • Practitioner
    • If the appointment contains a participant of type Practitioner
  • RelatedPerson
    • If the appointment contains a participant of type RelatedPerson
  • Location
    • If the appointment contains a participant of type Location

Formal Views of Profile Content

The official URL for this profile is:

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

This profile models an ehealth appointment. It is only necessary to create one appointment even though it spans more than one participant. Allowed appointment participants are patients, practitioners, relatedpersons, and locations

This profile builds on Appointment.

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 Appointment

Summary

Mandatory: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Terminology Bindings

PathNameConformanceValueSet
Appointment.languageCommon LanguagesextensibleCommon Languages
Appointment.statusAppointmentStatusrequiredAppointmentStatus
Appointment.serviceCategoryServiceCategoryexampleServiceCategory
Appointment.serviceTypeServiceTypeexampleServiceType
Appointment.specialtyPractice Setting Code Value SetpreferredPractice Setting Code Value Set
Appointment.appointmentTypeAppointmentTypeCodesextensibleAppointmentTypeCodes
Appointment.reasonEncounter Reason CodespreferredEncounter Reason Codes
Appointment.participant.typeParticipantTypeextensibleParticipantType
Appointment.participant.requiredParticipantRequiredrequiredParticipantRequired
Appointment.participant.statusParticipationStatusrequiredParticipationStatus

Constraints

IdPathDetailsRequirements
dom-2AppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1AppointmentIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4AppointmentIf 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-3AppointmentIf 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-3AppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))
app-2AppointmentEither start and end are specified, or neither
: start.empty() xor end.exists()
ele-1Appointment.participantAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
app-1Appointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
.