eHealth Infrastructure (v2021.2)

StructureDefinition: ehealth-group-appointment

Extra Validation Constraints

  • When a dateTime value is present in the ehealth-registration-deadline extension, then a WARNING validation issue will be raised if a participant is added to the appointment after this point in time
    • This constraint is implemented directly on the server due to technical limitations, which means it is not listed with other Implementation Guide constraints
  • The ehealth-creator extension value is managed by the server and holds a reference to the CareTeam that created the group appointment
    • When creating a new group appointment, the server automatically fills out this value based on the JWT CareTeam context of the user
    • Trying to assign a value different from the CareTeam in context when creating a group appointment, or changing this value in an update or patch operation, generates a http 422 error
    • The value is used by the security system of the server to allow the original creator of the group appointment to modify the appointment after creation, even when the creator is not the ehealth-responsible party

Formal Views of Profile Content

The official URL for this profile is:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-appointment

This profile models an ehealth appointment. It is only necessary to create one appointment even though it spans more than one participant. Allowed appointment participants are patients, practitioners, relatedpersons, and locations

This profile builds on Appointment.

This profile was published on Thu May 06 07:41:40 UTC 2021 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 Appointment

 

Terminology Bindings

PathConformanceValueSet
Appointment.languageextensibleCommon Languages
Max Binding: All Languages
Appointment.statusrequiredAppointmentStatus
Appointment.serviceCategoryexampleServiceCategory
Appointment.serviceTypeexampleServiceType
Appointment.specialtypreferredPractice Setting Code Value Set
Appointment.appointmentTypeextensibleAppointmentTypeCodes
Appointment.reasonrequiredAppointmentReason
Appointment.reason.codingrequiredAppointmentReason
Appointment.participant.typeextensibleParticipantType
Appointment.participant.requiredrequiredParticipantRequired
Appointment.participant.statusrequiredParticipationStatus

Constraints

IdPathDetailsRequirements
dom-2AppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1AppointmentIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4AppointmentIf 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-3AppointmentIf 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()
app-3AppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))
app-2AppointmentEither start and end are specified, or neither
: start.empty() xor end.exists()
responsible-1AppointmentEnsuring that responsible entity is a participating party
: (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference)
max-participantsAppointmentToo many intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger
min-participantsAppointmentToo few intended participants
: extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger
ele-1Appointment.extension:responsibleAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:responsibleMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:groupIdAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:groupIdMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:legalBasisAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:legalBasisMust have either extensions or value[x], not both
: extension.exists() != value.exists()
governance-1Appointment.extension:legalBasisWhen extension is used a Episode of Care MUST be referenced
: %resource.supportingInformation.reference.contains('EpisodeOfCare/')
responsible-2Appointment.extension:legalBasisBoth performing organization and responsible organization must be populated when legal basis is used
: %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists()
ele-1Appointment.extension:releasableResourceAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:releasableResourceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:responsible-organizationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:responsible-organizationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:performerAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:performerMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:ehealth-creatorAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:ehealth-creatorMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:intendedAudienceAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:intendedAudienceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:registration-deadlineAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:registration-deadlineMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:performing-organizationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:performing-organizationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.participantAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
app-1Appointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
ele-1Appointment.participant.extension:careteamAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.participant.extension:careteamMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.participant.extension:assigning-careteamAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.participant.extension:assigning-careteamMust have either extensions or value[x], not both
: extension.exists() != value.exists()
.