eHealth Infrastructure
10.0.0 - release Denmark flag

This page is part of the FUT Infrastructure (v10.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

OperationDefinition: Send message

Official URL: http://ehealth.sundhed.dk/fhir/OperationDefinition/Appointment-send-message Version: 10.0.0
Active as of 2026-08-06 Computable Name: Appointment-send-message

Sends a message to a RelatedPerson associated with a video appointment (ehealth-videoappointment or ehealth-group-videoappointment) via the specified channel. The recipient must be a RelatedPerson listed as a participant on the target Appointment. The created ehealth-message resource is system-generated; its sender is a contained Device representing the issuing system.

URL: [base]/Appointment/[id]/$send-message

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INrecipient1..1Reference (ehealth-relatedperson)

The related person to receive the message. Must be listed as a participant on the target Appointment.

INchannel1..1codeeHealth Message Channel (Required)

The channel to use when sending the message.

OUTreturn1..1Communication

The created Communication resource, conforming to the ehealth-message profile. Communication.status is completed on successful dispatch or stopped when the downstream gateway rejected the send.

The following preconditions must be satisfied — otherwise the operation returns HTTP 400 Bad Request with an OperationOutcome describing the violated rule:

  • Appointment.meta.profile is ehealth-videoappointment or ehealth-group-videoappointment.
  • Appointment.status is booked or pending.
  • The recipient RelatedPerson is on Appointment.participant[] with status accepted, tentative, or needs-action.
  • RelatedPerson.active = true.
  • RelatedPerson.period has begun and has not ended.
  • RelatedPerson.telecom[] has exactly one element with system = sms and an ehealth-telecom-purpose extension bound to video-appointment-reminder-sms.

The operation is synchronous and idempotent only from the FHIR caller's point of view: every successful call dispatches a new outbound message and creates a new Communication. The returned Communication has status = completed on successful dispatch or status = stopped when the downstream gateway rejected the send (the resource is still persisted so the failed attempt is auditable).