eHealth Infrastructure
2021.3.0 - build

eHealth Infrastructure - Local Development build (v2021.3.0). See the Directory of published versions

Resource Profile: ehealth-group-videoappointment

Defining URL:http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-videoappointment
Version:2021.3.0
Name:ehealth-group-videoappointment
Status:Active as of 2021-11-25T09:32:14+00:00
Publisher:Systematic | Trifork
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://ehealth.sundhed.dk/fhir/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

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Appointment

Summary

Mandatory: 8 elements (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Appointment.serviceType is sliced based on the value of value:coding.code

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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-vmr-uri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptLegal basis
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 performing organization and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... ehealth-creator 0..1Reference(ehealth-careteam) {r}Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference()The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeRegistration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... Slices for serviceType 1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
.... serviceType:appointmentType 1..1CodeableConceptThe specific service that is to be performed during this appointment
..... coding 0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: group-video
... appointmentType 1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode 0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... 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
... participant
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 0..1Reference()Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... actor 0..1Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | Location) {rc}Person, Location/HealthcareService or Device

doco Documentation for this format
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..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-meeting-url 0..1uriMeeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... ehealth-vmr-uri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptLegal basis
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 performing organization and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... ehealth-creator 0..1Reference(ehealth-careteam) {r}Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference()The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeRegistration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
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 | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... cancelationReason Σ0..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... Slices for serviceType Σ1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
Binding: ServiceType (example)
.... serviceType:appointmentType Σ1..1CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: group-video
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode Σ0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... reasonReference 0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the appointment is to take 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)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction 0..1stringDetailed information and instructions for the patient
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 0..1Reference()Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format
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

doco Documentation for this format

This structure is derived from Appointment

Summary

Mandatory: 8 elements (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Appointment.serviceType is sliced based on the value of value:coding.code

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
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-vmr-uri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptLegal basis
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 performing organization and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... ehealth-creator 0..1Reference(ehealth-careteam) {r}Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference()The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeRegistration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization
... Slices for serviceType 1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
.... serviceType:appointmentType 1..1CodeableConceptThe specific service that is to be performed during this appointment
..... coding 0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: group-video
... appointmentType 1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode 0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... 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
... participant
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 0..1Reference()Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... 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..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-end-meeting-on-end-time 0..1booleanIndicates if a video meeting must end on end time
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time
... ehealth-max-participants 0..1integerThe maximum number of participants allowed to participate in a video meeting
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants
... ehealth-meeting-url 0..1uriMeeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url
... ehealth-vmr-uri 0..1uriVideo meeting URL
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri
... ehealth-guest-pin-code 0..1stringGuest PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code
... ehealth-host-pin-code 0..1stringHost PIN code
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code
... ehealth-responsible 1..1Reference(ehealth-careteam | ehealth-practitioner) {r}Responsible careteam/practitioner
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible
... ehealth-group-id 0..1stringLogical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... ehealth-legalBasis I0..1CodeableConceptLegal basis
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 performing organization and responsible organization must be populated when legal basis is used
... ehealth-releasableResource 0..1booleanIndicates if the resource may be shared through national document repositories
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource
... ehealth-responsible-organization 0..1Reference(ehealth-organization) {r}Responsible organization
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization
... ehealth-performer 0..1Reference(ehealth-careteam | ehealth-practitioner) {r}Performer
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer
... ehealth-creator 0..1Reference(ehealth-careteam) {r}Creator Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-creator
... ehealth-intendedAudience 0..*Reference()The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-registration-deadline 0..1dateTimeRegistration deadline
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline
... ehealth-performing-organization 0..1Reference(ehealth-organization) {r}Organization who is performing in the given context
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 | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... cancelationReason Σ0..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... Slices for serviceType Σ1..*CodeableConceptThe specific service that is to be performed during this appointment
Slice: Unordered, Open by value:coding.code
Binding: ServiceType (example)
.... serviceType:appointmentType Σ1..1CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
Binding: Appointment Service Type (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: group-video
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ1..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Appointment Type Codes (required)
... reasonCode Σ0..1CodeableConceptCoded reason this appointment is scheduled
Binding: Appointment Reason (required)
... reasonReference 0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the appointment is to take 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)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction 0..1stringDetailed information and instructions for the patient
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant I1..*BackboneElementParticipants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ehealth-ext-careteam 0..1Reference(ehealth-careteam) {r}Careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam
.... ehealth-assigning-careteam 0..1Reference()Assigning careteam
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod 0..*PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Appointment.languagepreferredCommonLanguages
Max Binding: AllLanguages
Appointment.statusrequiredAppointmentStatus
Appointment.cancelationReasonexampleAppointmentCancellationReason
Appointment.serviceCategoryexampleServiceCategory
Appointment.serviceTypeexampleServiceType
Appointment.serviceType:appointmentTypeexampleServiceType
Appointment.serviceType:appointmentType.codingrequiredAppointmentServiceType
Appointment.specialtypreferredPracticeSettingCodeValueSet
Appointment.appointmentTyperequiredAppointmentTypeCodes
Appointment.reasonCoderequiredAppointmentReason
Appointment.participant.typeextensibleParticipantType
Appointment.participant.requiredrequiredParticipantRequired
Appointment.participant.statusrequiredParticipationStatus

Constraints

IdPathDetailsRequirements
app-2AppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3AppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4AppointmentCancelation reason is only used for appointments that have been cancelled, or no-show
: Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2AppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3AppointmentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5AppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6AppointmentA resource should have narrative for robust management
: text.`div`.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.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:endMeetingOnEndTimeAll FHIR elements must have a @value or children
: hasValue() or (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() or (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() or (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() or (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() or (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() or (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() or (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() or (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() or (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() or (children().count() > id.count())
ext-1Appointment.extension:releasableResourceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:responsibleOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.extension:responsibleOrganizationMust 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() or (children().count() > id.count())
ext-1Appointment.extension:performerMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:creatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.extension: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() or (children().count() > id.count())
ext-1Appointment.extension:intendedAudienceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:registrationDeadlineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.extension:registrationDeadlineMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:performingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.extension:performingOrganizationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.cancelationReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceCategoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentType.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.serviceType:appointmentType.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.serviceType:appointmentType.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentType.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.serviceType:appointmentType.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.serviceType:appointmentType.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentType.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentType.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentType.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentType.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceType:appointmentType.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.specialtyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.appointmentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.supportingInformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.endAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.minutesDurationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.slotAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.createdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.commentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.patientInstructionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
app-1Appointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
ele-1Appointment.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.participant.extension:careteamAll FHIR elements must have a @value or children
: hasValue() or (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:assigningCareteamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.participant.extension:assigningCareteamMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.participant.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.requiredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.requestedPeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())