eHealth Infrastructure (v2019.5.2)

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 Wed May 29 18:05:58 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse I0..*A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... 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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... appointment Σ1..1Reference(eHealth Appointment)Appointment this response relates to
... start 0..1instantTime from appointment, or requested new start time
... end 0..1instantTime from appointment, or requested new end time
... participantType Σ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
... participantStatus ?!Σ1..1codeaccepted | declined | tentative | in-process | completed | needs-action | entered-in-error
Binding: ParticipationStatus (required)
... comment 0..1stringAdditional comments

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse I0..*A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... 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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... appointment Σ1..1Reference(eHealth Appointment)Appointment this response relates to
... start 0..1instantTime from appointment, or requested new start time
... end 0..1instantTime from appointment, or requested new end time
... participantType Σ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
... participantStatus ?!Σ1..1codeaccepted | declined | tentative | in-process | completed | needs-action | entered-in-error
Binding: ParticipationStatus (required)
... comment 0..1stringAdditional comments

doco Documentation for this format

 

Terminology Bindings

PathNameConformanceValueSet
AppointmentResponse.languageCommon LanguagesextensibleCommon Languages
AppointmentResponse.participantTypeParticipantTypeextensibleParticipantType
AppointmentResponse.participantStatusParticipationStatusrequiredParticipationStatus

Constraints

IdPathDetailsRequirements
dom-2AppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1AppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4AppointmentResponseIf 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-3AppointmentResponseIf 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-1AppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
.