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:

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..*ExtensionSlice: 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..1CodeableConceptBinding: AppointmentTypeCodes (extensible)
... reason 1..*CodeableConcept
... indication 0..*Reference(Condition | Procedure) {r}
... supportingInformation 0..*Reference(Resource) {r}
... slot 0..*Reference(Slot) {r}
... incomingReferral 0..*Reference(ReferralRequest) {r}
... participant 2..*BackboneElement
.... actor 0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location)

doco Documentation for this format

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-responsible 1..1(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required)
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe 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..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: AppointmentTypeCodes (extensible)
... reason Σ1..*CodeableConceptReason this appointment is scheduled
Binding: Encounter Reason Codes (preferred)
... indication 0..*Reference(Condition | Procedure) {r}Reason the appointment is to takes place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource) {r}Additional information to support the appointment
... start Σ0..1instantWhen appointment is to take place
... end Σ0..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot) {r}The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... incomingReferral 0..*Reference(ReferralRequest) {r}The ReferralRequest provided as information to allocate to the Encounter
... participant I2..*BackboneElementParticipants involved in appointment
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible)
.... actor Σ0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status 1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

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:

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..*ExtensionSlice: 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..1CodeableConceptBinding: AppointmentTypeCodes (extensible)
... reason 1..*CodeableConcept
... indication 0..*Reference(Condition | Procedure) {r}
... supportingInformation 0..*Reference(Resource) {r}
... slot 0..*Reference(Slot) {r}
... incomingReferral 0..*Reference(ReferralRequest) {r}
... participant 2..*BackboneElement
.... actor 0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-responsible 1..1(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required)
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe 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..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: AppointmentTypeCodes (extensible)
... reason Σ1..*CodeableConceptReason this appointment is scheduled
Binding: Encounter Reason Codes (preferred)
... indication 0..*Reference(Condition | Procedure) {r}Reason the appointment is to takes place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource) {r}Additional information to support the appointment
... start Σ0..1instantWhen appointment is to take place
... end Σ0..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot) {r}The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... incomingReferral 0..*Reference(ReferralRequest) {r}The ReferralRequest provided as information to allocate to the Encounter
... participant I2..*BackboneElementParticipants involved in appointment
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible)
.... actor Σ0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status 1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

 

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()
.