eHealth Infrastructure (v2021.2)

StructureDefinition: ehealth-group-videoappointment

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-videoappointment

This profile models an ehealth group video appointment. It is only necessary to create one appointment even though it spans more than one participant. Allowed appointment participants are careteams, 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

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-meeting-url 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... ehealth-vmr-uri 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(eHealth CareTeam | eHealth Practitioner) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis
Binding: Jurisdiction (required)
governance-1: When extension is used a Episode of Care MUST be referenced
responsible-2: Both performer and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
.... valueReference:valueReference 0..1Reference(eHealth Practitioner | eHealth CareTeam) {r}Value of extension
... ehealth-creator 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference(eHealth Organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... appointmentType 1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (extensible)
... reason 1..*CodeableConceptReason this appointment is scheduled
Binding: Appointment Reason (preferred)
.... coding 0..*CodingCode defined by a terminology system
Binding: Appointment Reason (required)
... indication 0..*Reference(Condition | Procedure) {r}Reason the appointment is to takes place (resource)
... description 1..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r}Additional information to support the appointment
... start 1..1instantWhen appointment is to take place
... end 1..1instantWhen appointment is to conclude
... slot 0..*Reference(Slot) {r}The slots that this appointment is filling
... incomingReferral 0..*Reference(ReferralRequest) {r}The ReferralRequest provided as information to allocate to the Encounter
... participant
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 1..1Reference(eHealth CareTeam)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
..... valueReference:valueReference 0..1Reference(eHealth CareTeam) {r}Value of extension
.... actor 0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc}Person, Location/HealthcareService or Device

doco Documentation for this format

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-meeting-url 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... ehealth-vmr-uri 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(eHealth CareTeam | eHealth Practitioner) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis
Binding: Jurisdiction (required)
governance-1: When extension is used a Episode of Care MUST be referenced
responsible-2: Both performer and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer"
.... value[x]:valueReference 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 0..1Reference(eHealth Practitioner | eHealth CareTeam) {r}Value of extension
... ehealth-creator 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference(eHealth Organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred)
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (extensible)
... reason Σ1..*CodeableConceptReason this appointment is scheduled
Binding: Appointment Reason (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Reason (required)
.... text Σ0..1stringPlain text representation of the concept
... indication 0..*Reference(Condition | Procedure) {r}Reason the appointment is to takes place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 1..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r}Additional information to support the appointment
... start Σ1..1instantWhen appointment is to take place
... end Σ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot) {r}The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... incomingReferral 0..*Reference(ReferralRequest) {r}The ReferralRequest provided as information to allocate to the Encounter
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 1..1Reference(eHealth CareTeam)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 0..1Reference(eHealth CareTeam) {r}Value of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor Σ0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc}Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status 1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

This structure is derived from Appointment

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-meeting-url 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... ehealth-vmr-uri 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(eHealth CareTeam | eHealth Practitioner) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis
Binding: Jurisdiction (required)
governance-1: When extension is used a Episode of Care MUST be referenced
responsible-2: Both performer and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
.... valueReference:valueReference 0..1Reference(eHealth Practitioner | eHealth CareTeam) {r}Value of extension
... ehealth-creator 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference(eHealth Organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... appointmentType 1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (extensible)
... reason 1..*CodeableConceptReason this appointment is scheduled
Binding: Appointment Reason (preferred)
.... coding 0..*CodingCode defined by a terminology system
Binding: Appointment Reason (required)
... indication 0..*Reference(Condition | Procedure) {r}Reason the appointment is to takes place (resource)
... description 1..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r}Additional information to support the appointment
... start 1..1instantWhen appointment is to take place
... end 1..1instantWhen appointment is to conclude
... slot 0..*Reference(Slot) {r}The slots that this appointment is filling
... incomingReferral 0..*Reference(ReferralRequest) {r}The ReferralRequest provided as information to allocate to the Encounter
... participant
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 1..1Reference(eHealth CareTeam)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
..... valueReference:valueReference 0..1Reference(eHealth CareTeam) {r}Value of extension
.... actor 0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc}Person, Location/HealthcareService or Device

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
responsible-1: Ensuring that responsible entity is a participating party
max-participants: Too many intended participants
min-participants: Too few intended participants
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-meeting-url 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... ehealth-vmr-uri 0..1uriExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(eHealth CareTeam | eHealth Practitioner) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-legalBasis
Binding: Jurisdiction (required)
governance-1: When extension is used a Episode of Care MUST be referenced
responsible-2: Both performer and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer"
.... value[x]:valueReference 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 0..1Reference(eHealth Practitioner | eHealth CareTeam) {r}Value of extension
... ehealth-creator 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference(eHealth Organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(eHealth Organization) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!Σ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred)
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (extensible)
... reason Σ1..*CodeableConceptReason this appointment is scheduled
Binding: Appointment Reason (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Reason (required)
.... text Σ0..1stringPlain text representation of the concept
... indication 0..*Reference(Condition | Procedure) {r}Reason the appointment is to takes place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 1..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..1Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r}Additional information to support the appointment
... start Σ1..1instantWhen appointment is to take place
... end Σ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot) {r}The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... incomingReferral 0..*Reference(ReferralRequest) {r}The ReferralRequest provided as information to allocate to the Encounter
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(eHealth CareTeam) {r}Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 1..1Reference(eHealth CareTeam)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 0..1Reference(eHealth CareTeam) {r}Value of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor Σ0..1Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc}Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status 1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

 

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.reasonpreferredAppointmentReason
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:endMeetingOnEndTimeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:endMeetingOnEndTimeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:maxParticipantsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:maxParticipantsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:meetingURLAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:meetingURLMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:vmrUriAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:vmrUriMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:guestPinCodeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:guestPinCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:hostPinCodeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Appointment.extension:hostPinCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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 performer 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()
.