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).
Den telemedicinske infrastruktur (eHealth Infrastructure)
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.
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).
The related person to receive the message. Must be listed as a participant on the target Appointment.
The channel to use when sending the message.
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.