WARNING
validation issue will be raised if a participant is added to the appointment after this point in time
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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 0..* | Appointment | A 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..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time | |
ehealth-max-participants | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants | |
ehealth-meeting-url | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
ehealth-vmr-uri | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
ehealth-guest-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
ehealth-host-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
ehealth-responsible | 1..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
ehealth-group-id | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension 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..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
ehealth-responsible-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
ehealth-performer | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
valueReference:valueReference | 0..1 | Reference(eHealth Practitioner | eHealth CareTeam) {r} | Value of extension | |
ehealth-creator | 0..1 | Reference(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..1 | dateTime | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |
ehealth-performing-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) | |
reason | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) | |
coding | 0..* | Coding | Code 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..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | 1..1 | instant | When appointment is to take place | |
end | 1..1 | instant | When 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..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | 0..1 | Reference(eHealth CareTeam) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
ehealth-assigning-careteam | 1..1 | Reference(eHealth CareTeam) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |
valueReference:valueReference | 0..1 | Reference(eHealth CareTeam) {r} | Value of extension | |
actor | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device | |
Documentation for this format |
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 0..* | Appointment | A 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..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time | |
ehealth-max-participants | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants | |
ehealth-meeting-url | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
ehealth-vmr-uri | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
ehealth-guest-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
ehealth-host-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
ehealth-responsible | 1..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
ehealth-group-id | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension 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..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
ehealth-responsible-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
ehealth-performer | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "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..1 | Reference(eHealth Practitioner | eHealth CareTeam) {r} | Value of extension | |
ehealth-creator | 0..1 | Reference(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..1 | dateTime | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |
ehealth-performing-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this item |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error Binding: AppointmentStatus (required): The free/busy status of an appointment. |
serviceCategory | Σ | 0..1 | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
specialty | Σ | 0..* | CodeableConcept | The 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..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) |
reason | Σ | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Reason (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
indication | 0..* | Reference(Condition | Procedure) {r} | Reason the appointment is to takes place (resource) | |
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |
description | 1..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | Σ | 1..1 | instant | When appointment is to take place |
end | Σ | 1..1 | instant | When appointment is to conclude |
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
slot | 0..* | Reference(Slot) {r} | The slots that this appointment is filling | |
created | 0..1 | dateTime | The date that this appointment was initially created | |
comment | 0..1 | string | Additional comments | |
incomingReferral | 0..* | Reference(ReferralRequest) {r} | The ReferralRequest provided as information to allocate to the Encounter | |
participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | 0..1 | Reference(eHealth CareTeam) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
ehealth-assigning-careteam | 1..1 | Reference(eHealth CareTeam) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "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..1 | Reference(eHealth CareTeam) {r} | Value of extension | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
actor | Σ | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device |
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. |
status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |
requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 0..* | Appointment | A 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..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time | |
ehealth-max-participants | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants | |
ehealth-meeting-url | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
ehealth-vmr-uri | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
ehealth-guest-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
ehealth-host-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
ehealth-responsible | 1..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
ehealth-group-id | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension 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..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
ehealth-responsible-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
ehealth-performer | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
valueReference:valueReference | 0..1 | Reference(eHealth Practitioner | eHealth CareTeam) {r} | Value of extension | |
ehealth-creator | 0..1 | Reference(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..1 | dateTime | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |
ehealth-performing-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) | |
reason | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) | |
coding | 0..* | Coding | Code 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..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | 1..1 | instant | When appointment is to take place | |
end | 1..1 | instant | When 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..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | 0..1 | Reference(eHealth CareTeam) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
ehealth-assigning-careteam | 1..1 | Reference(eHealth CareTeam) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |
valueReference:valueReference | 0..1 | Reference(eHealth CareTeam) {r} | Value of extension | |
actor | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 0..* | Appointment | A 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..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-end-meeting-on-end-time | 0..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-end-meeting-on-end-time | |
ehealth-max-participants | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants | |
ehealth-meeting-url | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-meeting-url | |
ehealth-vmr-uri | 0..1 | uri | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-vmr-uri | |
ehealth-guest-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guest-pin-code | |
ehealth-host-pin-code | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-host-pin-code | |
ehealth-responsible | 1..1 | Reference(eHealth CareTeam | eHealth Practitioner) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible | |
ehealth-group-id | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id | |
ehealth-legalBasis | I | 0..1 | CodeableConcept | Extension 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..1 | boolean | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-releasableResource | |
ehealth-responsible-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization | |
ehealth-performer | 0..1 | Reference(eHealth CareTeam | eHealth Practitioner | eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performer | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "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..1 | Reference(eHealth Practitioner | eHealth CareTeam) {r} | Value of extension | |
ehealth-creator | 0..1 | Reference(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..1 | dateTime | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-registration-deadline | |
ehealth-performing-organization | 0..1 | Reference(eHealth Organization) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this item |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error Binding: AppointmentStatus (required): The free/busy status of an appointment. |
serviceCategory | Σ | 0..1 | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
specialty | Σ | 0..* | CodeableConcept | The 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..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type Codes (extensible) |
reason | Σ | 1..* | CodeableConcept | Reason this appointment is scheduled Binding: Appointment Reason (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: Appointment Reason (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
indication | 0..* | Reference(Condition | Procedure) {r} | Reason the appointment is to takes place (resource) | |
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |
description | 1..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | 0..1 | Reference(eHealth EpisodeOfCare | eHealth CarePlan) {r} | Additional information to support the appointment | |
start | Σ | 1..1 | instant | When appointment is to take place |
end | Σ | 1..1 | instant | When appointment is to conclude |
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
slot | 0..* | Reference(Slot) {r} | The slots that this appointment is filling | |
created | 0..1 | dateTime | The date that this appointment was initially created | |
comment | 0..1 | string | Additional comments | |
incomingReferral | 0..* | Reference(ReferralRequest) {r} | The ReferralRequest provided as information to allocate to the Encounter | |
participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-ext-careteam | 0..1 | Reference(eHealth CareTeam) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam | |
ehealth-assigning-careteam | 1..1 | Reference(eHealth CareTeam) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-assigning-careteam | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "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..1 | Reference(eHealth CareTeam) {r} | Value of extension | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
actor | Σ | 0..1 | Reference(eHealth Patient | eHealth Practitioner | eHealth RelatedPerson | Location) {rc} | Person, Location/HealthcareService or Device |
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. |
status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |
requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
Documentation for this format |
Path | Conformance | ValueSet |
Appointment.language | extensible | Common Languages Max Binding: All Languages |
Appointment.status | required | AppointmentStatus |
Appointment.serviceCategory | example | ServiceCategory |
Appointment.serviceType | example | ServiceType |
Appointment.specialty | preferred | Practice Setting Code Value Set |
Appointment.appointmentType | extensible | AppointmentTypeCodes |
Appointment.reason | preferred | AppointmentReason |
Appointment.reason.coding | required | AppointmentReason |
Appointment.participant.type | extensible | ParticipantType |
Appointment.participant.required | required | ParticipantRequired |
Appointment.participant.status | required | ParticipationStatus |
Id | Path | Details | Requirements |
dom-2 | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Appointment | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Appointment | If 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-3 | Appointment | If 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-3 | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled')) | |
app-2 | Appointment | Either start and end are specified, or neither : start.empty() xor end.exists() | |
responsible-1 | Appointment | Ensuring 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-participants | Appointment | Too 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-participants | Appointment | Too 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-1 | Appointment.extension:endMeetingOnEndTime | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:endMeetingOnEndTime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:maxParticipants | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:maxParticipants | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:meetingURL | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:meetingURL | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:vmrUri | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:vmrUri | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:guestPinCode | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:guestPinCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:hostPinCode | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:hostPinCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:responsible | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:responsible | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:groupId | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:groupId | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:legalBasis | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:legalBasis | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
governance-1 | Appointment.extension:legalBasis | When extension is used a Episode of Care MUST be referenced : %resource.supportingInformation.reference.contains('EpisodeOfCare/') | |
responsible-2 | Appointment.extension:legalBasis | Both 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-1 | Appointment.extension:releasableResource | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:releasableResource | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:responsible-organization | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:responsible-organization | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:performer | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:performer | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:ehealth-creator | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:ehealth-creator | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:intendedAudience | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:intendedAudience | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:registration-deadline | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:registration-deadline | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension:performing-organization | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.extension:performing-organization | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.participant | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
app-1 | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
ele-1 | Appointment.participant.extension:careteam | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.participant.extension:careteam | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.participant.extension:assigning-careteam | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Appointment.participant.extension:assigning-careteam | Must have either extensions or value[x], not both : extension.exists() != value.exists() |