Appointment-send-message
type: OperationDefinition
node role: treeRoot
resource.id:
  value: Appointment-send-message
domain resource.text:
  narrative.status:
    value: generated
  narrative.div: Generated Narrative: OperationDefinition Appointment-send-message URL: [base]/Appointment/[id]/$send-message Parameters Use Name Scope Cardinality Type Binding Documentation IN recipient 1..1 Reference (ehealth-relatedperson) The related person to receive the message. Must be listed as a participant on the target Appointment. IN channel 1..1 code eHealth Message Channel (Required) The channel to use when sending the message. OUT return 1..1 Communication 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).
operation definition.url:
  value: http://ehealth.sundhed.dk/fhir/OperationDefinition/Appointment-send-message
operation definition.version:
  value: 10.0.0
operation definition.name:
  value: Appointment-send-message
operation definition.title:
  value: Send message
operation definition.status:
  value: active
operation definition.kind:
  value: operation
operation definition.date:
  value: 2026-08-06T13:29:38+00:00
operation definition.publisher:
  value: Den telemedicinske infrastruktur (eHealth Infrastructure)
operation definition.contact:
  index: 0
  contact detail.name:
    value: Den telemedicinske infrastruktur (eHealth Infrastructure)
  contact detail.telecom:
    index: 0
    contact point.system:
      value: url
    contact point.value:
      value: http://ehealth.sundhed.dk
operation definition.description:
  value: Sends a message to a [RelatedPerson](StructureDefinition-ehealth-relatedperson.html) associated with a video appointment ([ehealth-videoappointment](StructureDefinition-ehealth-videoappointment.html) or [ehealth-group-videoappointment](StructureDefinition-ehealth-group-videoappointment.html)) via the specified channel. The recipient must be a RelatedPerson listed as a participant on the target Appointment. The created [ehealth-message](StructureDefinition-ehealth-message.html) resource is system-generated; its `sender` is a contained Device representing the issuing system.
operation definition.jurisdiction:
  index: 0
  codeable concept.coding:
    index: 0
    coding.system:
      value: urn:iso:std:iso:3166
    coding.code:
      value: DK
    coding.display:
      value: Denmark
operation definition.affects state:
  value: true
operation definition.code:
  value: send-message
operation definition.comment:
  value: 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](StructureDefinition-ehealth-videoappointment.html) or [ehealth-group-videoappointment](StructureDefinition-ehealth-group-videoappointment.html). * `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](StructureDefinition-ehealth-telecom-purpose.html) 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).
operation definition.resource:
  value: Appointment
  index: 0
operation definition.system:
  value: false
operation definition.type:
  value: false
operation definition.instance:
  value: true
operation definition.parameter:
  index: 0
  operation definition.parameter.name:
    value: recipient
  operation definition.parameter.use:
    value: in
  operation definition.parameter.min:
    value: 1
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The related person to receive the message. Must be listed as a participant on the target Appointment.
  operation definition.parameter.type:
    value: Reference
  operation definition.parameter.target profile:
    value: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-relatedperson
    index: 0
    link: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-relatedperson
operation definition.parameter:
  index: 1
  operation definition.parameter.name:
    value: channel
  operation definition.parameter.use:
    value: in
  operation definition.parameter.min:
    value: 1
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The channel to use when sending the message.
  operation definition.parameter.type:
    value: code
  operation definition.parameter.binding:
    operation definition.parameter.binding.strength:
      value: required
    operation definition.parameter.binding.value set:
      value: http://ehealth.sundhed.dk/vs/ehealth-message-channel
      link: http://ehealth.sundhed.dk/vs/ehealth-message-channel
operation definition.parameter:
  index: 2
  operation definition.parameter.name:
    value: return
  operation definition.parameter.use:
    value: out
  operation definition.parameter.min:
    value: 1
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The created Communication resource, conforming to the [ehealth-message](StructureDefinition-ehealth-message.html) profile. `Communication.status` is `completed` on successful dispatch or `stopped` when the downstream gateway rejected the send.
  operation definition.parameter.type:
    value: Communication