AddCommunication Implementation Guide
2.2 - version 2.2

This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Releasenotes

This section describes what is new or changed in each version

Version 2.2 - used in V2.2 of AddCommunication API

  • OtherCommunicationRequest:
    • New resource to hold information about for example communication not related to appointments.
    • New ValueSet for Non-appointment ActionTypes, used in OtherCommunicationRequest
  • ReferralReference:
    • New extension to hold information about referred HealthcareUnit. Used in InvitationAppointment and OtherCommunicationReqeust. Contains:
      • Reference to a HealthcareService,
      • Integer for GAP days
      • Flag if correspondance shall be sent to referred HealthcareService
  • VisitType:
    • New Extension for VisitType. Used in InvitationAppointment
    • New ValueSet for VisitType. Used in InvitationAppointment
    • ReschedulingReason:
    • New Extension for ReschedulingReason. Used in InvitationAppointment
    • New ValueSet for ReschedulingReason. Used in InvitationAppointment
  • InvitationAppointment:
    • VisitType is added. Value from ValueSet VisitType: NEW|FOLLOWUP
    • ReferralReference is added
    • Participant:referrer is removed. ReferralReference shall be used insted
    • Cardinality on Participant is changed to 1..2. There must be a HealthcareService, there might be a Practitioner.
  • CommunicationHealthcareService:
    • Identifier or Location + Phone number must be provided
    • contact.telecom added for phone number
  • Location:
    • Stricter cardinalities on Address. If Address is included there must be zip, city and at least one Address Line. Applies to all addresses: Patient, RelatedPerson and Location.
  • InvitationActionTypes
    • PROPOSAL_REFERRAL removed
    • DISCHARGE added
  • NonAppointmentInvitationActionTypes
    • CONFIRMATION_WITHIN_CARE_GUARANTEE Confirmation within Care Guarantee
    • CONFIRMATION_OUTSIDE_CARE_GUARANTEE_WITH_COORDINATION Confirmation outside Care Guarantee
    • CONFIRMATION_OUTSIDE_CARE_GUARANTEE_WITHOUT_COORDINATION Confirmation outside Care Guarantee
    • WAIT_TIME_CHANGED_COORDINATION_VIA_ANOTHER_REGION
    • CANCEL_REFERRAL_ON_PATIENT_REQUEST Referral cancelled on patient request
    • CANCEL_REFERRAL_PATIENT_NOT_REACHABLE
  • SelfCheckin
    • New Extension for SelfCheckin. Used in InvitationAppointment
  • ReminderAppointment:
    • Cardinality on Participant is changed to 1..1. There must be a HealthcareService.
    • Cardinality on AppointmentType is changed to 1..1. There must be an AppointmentType
  • InvitationAppointment:
    • Freetext can be added by adding an IndividualChoice extension with type = 'FreeTextField'.
  • InvitationCommunicationRequest:
    • To be able to set a flag for resolving guardian from PU instead of sending it with the request, field ResolveGuardianFrom PU has been added 0..1 (boolean)
  • Parameters:
    • Constraint to check InvitationActionType in InvitationCommunicationRequest. If VisitType is NEW and ReferralReference.ReceiveCorrespondence = true, InvitationActionType must be either BOOK or RESCHEDULE

Version 2.1 - used in V2.1 of AddCommunication API

  • CommunicationParameters:
    • meta.source is added to hold Healthcare system id. Used to route form response. Mandatory, 1..1
  • InvitationAppointment:
    • Identifier (AppointmentId) is mandatory.
    • Participant.actor.type is mandatory 1..1.
    • New slice for Referring HealthcareService with type = #REF. There must be a participant.actor reference to HealthCareService with type = #ADM. There can be a participant.actor with reference to Participant and type = ATND. CareService.
    • CareServiceArea is added and mandatory 1..1.
  • InvitationCommunicationRequest:
    • There must be at least one reference to appointment. Cardinality for about is changed to 1..*
  • Patient.address:
    • It is now possible to specify several addresses for a patient. Home and Temp addresses can be added in patient.address.
    • Patient.use must be set to #home or #temp.
    • It is possible to specify the Period an address is valid
  • CommunicationRelatedPerson:
    • New profile to hold information about Next-of-kin and Legal guardian.
    • Relatedperson.relationship.code and Relatedperson.patient must be specified
  • Patient.link:
    • Link is added to be able to specify Next-of-kin and Legal guardian.
    • Link is not mandatory, but if added, link.other and link.type must be specified.
    • Link.other is a Reference to RelatedPerson.
    • Link.type is #NOK for Next-of-Kin or #GUARD for Legal guradian.
  • Country and District:
    • It is possible to specify Country and District (country) to patient.Address, relatedPerson.Address and location.Address
  • ReminderAppointment:
    • AppointmentType added with cardinality 0..1
  • InvitationCommunicationRequest:
    • To be able to set a flag for Manual handling of prints, field DigitalOnly has been added 0..1 (boolean)
  • Extensions with changed data types:
    • These fields have changed from string to integer: IndividualChoice.Id, PrepItem.Id, Placeholder.Id
  • ReminderAppointment:
    • Constraint for participant.actor. Must be a reference to HealthcareService. CareServiceArea is added and mandatory, 1..1.

Version 2.0 - used in V2 of AddCommunication API

  • ReschdeuledAppointment: Reference to the appointment that was rescheduled can be added to the InvitationAppointment.replaces element.

  • Parameters resource: is replacing the Bundle. This means that there is a new structure for all referenced resources. Instead of using contained resources, all references are added as parameter entries. References are created the same way as with the contained resources previously.

  • Patient: moved from Bundle to Reminder and Invitation: Patient information is now on Reminder/Invitation level instead of in Bundle. Patient is added as a reference in the Parameters resource and in the subject element of the ReminderCommunicationRequest and InvitationCommunicationRequest.

  • CareServiceCode: is now a CodableContext and is mandatory (1..1) in ReminderAppointment and InvitationAppointment. Coding.value must contain the code and is mandatory (1..1), coding.system can contain the OID or BKI for the codesystem that holds the code, coding.display can contain a display vaLue

  • Several Appointments: Invitations can have several Appointments. InvitationCommunicationRequest.About 0..*

  • Section: Section extension has been removed from InvitationCommunicaationRequest

  • IndividualChoices and Preps: New extensions in InvitationAppointment to hold IndividualChoices, Preps, PrepItems and Links

  • Practitioner: Is included in InvitationAppointment as slice of participant.actor. Practitioner is not mandatory but if added, articipant status must be provided

  • HealthcareService: Is included in InvitationAppointment as a slice of participant.actor. There must be at least one HealthcareService. Participant status must be provided, for example participant[healthcareservice].status = #accepted

  • CancellationReason: added to InvitationCommunicationRequest. Appointment.status must be cancelled or noshow to be able to submit a cancellationReason.

  • ActionType: New types have been added for open invitations in KallaInvitationActionType

  • Meta.VersionId: Is mandatory in InvitationCommunicationRequest and ReminderCommunicationRequest. Meta.verisonId is used to distinguish Reminders and Invitations if adding several in a bundle but shall always be provided. It can be a GUID or other unique string

  • ScheduledAtUtc: in ReminderCommunicationRequest. Constraint has been corrected to match description. It is possible to submit reminders with a ScheduledAtUtc date which is today or in the future.

Appointment.start and Appointment.end: To be able to submit proposed invitations without specifying start and end, Appointment.status must be set to one of: 'proposed' 'cancelled' 'waitlist'

Version 0.0.9

  • Codesystem and ValueSet for Appointment Types
  • AppointmentType is mandatory in InvitationCommunicationRequest
  • Examples with AppointmentType

Version 0.0.8 - used in V1 of AddCommunication API

  • informationProvider is reference to HealthCareService in the examples
  • ScheduledAtUtc dates later in future
  • Adding meta.versionId
  • Minor adjustments: examples, removed unused comments

Version 0.0.7

  • Participant is mandatory in ReminderAppointment and InvitationAppointment