eHealth Infrastructure - Local Development build (v2.5.0). See the Directory of published versions
Active as of 2023-02-09 |
Definitions for the ehealth-videoappointment resource profile.
1. Appointment | |
Invariants | Defined on this element responsible-1: 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)) single-patient-appointment: Only a single patient is allowed pr. appointment (: participant.actor.where(reference.contains('/Patient')).count() < 2) |
2. Appointment.extension | |
Control | 10..* |
Slicing | This element introduces a set of slices on Appointment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
3. Appointment.extension:endMeetingOnEndTime | |
SliceName | endMeetingOnEndTime |
Control | 0..1 |
Type | Extension(ehealth-end-meeting-on-end-time) (Extension Type: boolean) |
4. Appointment.extension:maxParticipants | |
SliceName | maxParticipants |
Control | 0..1 |
Type | Extension(ehealth-max-participants) (Extension Type: integer) |
5. Appointment.extension:meetingUrl | |
SliceName | meetingUrl |
Control | 0..1 |
Type | Extension(ehealth-meeting-url) (Extension Type: uri) |
6. Appointment.extension:vmrUri | |
SliceName | vmrUri |
Control | 0..1 |
Type | Extension(ehealth-vmr-uri) (Extension Type: uri) |
7. Appointment.extension:guestPinCode | |
SliceName | guestPinCode |
Control | 0..1 |
Type | Extension(ehealth-guest-pin-code) (Extension Type: string) |
8. Appointment.extension:hostPinCode | |
SliceName | hostPinCode |
Control | 0..1 |
Type | Extension(ehealth-host-pin-code) (Extension Type: string) |
9. Appointment.extension:responsible | |
SliceName | responsible |
Control | 1..1 |
Type | Extension(ehealth-responsible) (Extension Type: Reference(ehealth-careteamehealth-practitioner) : {r})) |
10. Appointment.extension:groupId | |
SliceName | groupId |
Control | 0..1 |
Type | Extension(ehealth-group-id) (Extension Type: string) |
11. Appointment.extension:legalBasis | |
SliceName | legalBasis |
Control | 0..1 |
Type | Extension(ehealth-legalBasis) (Extension Type: CodeableConcept) |
Invariants | Defined on this element governance-1: When extension is used a Episode of Care MUST be referenced (: %resource.supportingInformation.reference.contains('EpisodeOfCare/')) responsible-2: Both 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()) |
12. Appointment.extension:releasableResource | |
SliceName | releasableResource |
Control | 0..1 |
Type | Extension(ehealth-releasableResource) (Extension Type: boolean) |
13. Appointment.extension:responsibleOrganization | |
SliceName | responsibleOrganization |
Control | 0..1 |
Type | Extension(ehealth-responsible-organization) (Extension Type: Reference(ehealth-organization) : {r})) |
14. Appointment.extension:performer | |
SliceName | performer |
Control | 0..1 |
Type | Extension(ehealth-performer) (Extension Type: Reference(ehealth-careteamehealth-practitioner) : {r})) |
15. Appointment.extension:performingOrganization | |
SliceName | performingOrganization |
Control | 0..1 |
Type | Extension(ehealth-performing-organization) (Extension Type: Reference(ehealth-organization) : {r})) |
16. Appointment.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Slicing | This element introduces a set of slices on Appointment.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
17. Appointment.identifier:vdxMeetingId | |
SliceName | vdxMeetingId |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
18. Appointment.identifier:vdxMeetingId.system | |
Control | 1..? |
Fixed Value | http://vdx.medcom.dk/meeting |
19. Appointment.serviceType | |
Control | 10..* |
Slicing | This element introduces a set of slices on Appointment.serviceType. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
20. Appointment.serviceType:appointmentType | |
SliceName | appointmentType |
Control | 1..1 |
21. Appointment.serviceType:appointmentType.coding | |
Control | 0..? |
Binding | The codes SHALL be taken from Appointment Service Type |
22. Appointment.serviceType:appointmentType.coding.code | |
Control | 1..? |
Fixed Value | video |
23. Appointment.appointmentType | |
Control | 10..1 |
Binding | The codes SHALL be taken from Appointment Type CodesThe codes SHOULD be taken from hl7VS-appointmentReasonCodes |
24. Appointment.reasonCode | |
Control | 0..1* |
Binding | The codes SHALL be taken from Appointment ReasonThe codes SHOULD be taken from EncounterReasonCodes |
25. Appointment.supportingInformation | |
Control | 0..1* |
Type | Reference(ehealth-episodeofcare|ehealth-careplan|Resource) : {r}) |
26. Appointment.start | |
Control | 10..1 |
27. Appointment.end | |
Control | 10..1 |
28. Appointment.participant | |
Control | 0..? |
29. Appointment.participant.extension | |
Slicing | This element introduces a set of slices on Appointment.participant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
30. Appointment.participant.extension:careteam | |
SliceName | careteam |
Control | 0..1 |
Type | Extension(ehealth-ext-careteam) (Extension Type: Reference(ehealth-careteam) : {r})) |
31. Appointment.participant.actor | |
Type | Reference(ehealth-patient|ehealth-practitioner|ehealth-relatedperson|Location|Patient|Practitioner|PractitionerRole|RelatedPerson|Device|HealthcareService) : {r}, {r}, {c}) |
1. Appointment | |
Definition | 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). |
Control | 0..* |
Invariants | Defined on this element app-2: Either start and end are specified, or neither (: start.exists() = end.exists()) app-3: Only proposed or cancelled appointments can be missing start/end dates (: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))) app-4: Cancelation 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-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If 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-4: 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-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) responsible-1: 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)) single-patient-appointment: Only a single patient is allowed pr. appointment (: participant.actor.where(reference.contains('/Patient')).count() < 2) |
2. Appointment.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. Appointment.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 10..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Appointment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Appointment.extension:endMeetingOnEndTime | |
SliceName | endMeetingOnEndTime |
Definition | Indicates if a video meeting must end on end time |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-end-meeting-on-end-time) (Extension Type: boolean) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
5. Appointment.extension:maxParticipants | |
SliceName | maxParticipants |
Definition | The maximum number of participants allowed to participate in a video meeting |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-max-participants) (Extension Type: integer) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
6. Appointment.extension:meetingUrl | |
SliceName | meetingUrl |
Definition | The URL at which a video meeting will take place. Is provided by the service, not the client, and may not be updated |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-meeting-url) (Extension Type: uri) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
7. Appointment.extension:vmrUri | |
SliceName | vmrUri |
Definition | Virtual Meeting Room URI that can be used in eg. webRTC clients. Is provided by the service, not the client, and may not be updated. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-vmr-uri) (Extension Type: uri) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
8. Appointment.extension:guestPinCode | |
SliceName | guestPinCode |
Definition | The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-guest-pin-code) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
9. Appointment.extension:hostPinCode | |
SliceName | hostPinCode |
Definition | The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable. Host PIN must be used in order to start the meeting |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-host-pin-code) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. Appointment.extension:responsible | |
SliceName | responsible |
Definition | Individuals, careteam and/or organization who are responsible in the given context |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-responsible) (Extension Type: Reference(ehealth-careteamehealth-practitioner) : {r})) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
11. Appointment.extension:groupId | |
SliceName | groupId |
Definition | A logical id identifying a set of messages, which have the same recipient (considered a 'group message'). Must be supplied by the client, eg. as a UUID |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-group-id) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
12. Appointment.extension:legalBasis | |
SliceName | legalBasis |
Definition | Legal basis |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-legalBasis) (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) governance-1: When extension is used a Episode of Care MUST be referenced (: %resource.supportingInformation.reference.contains('EpisodeOfCare/')) responsible-2: Both 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()) |
13. Appointment.extension:releasableResource | |
SliceName | releasableResource |
Definition | Indicates if the resource may be shared through national document repositories |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-releasableResource) (Extension Type: boolean) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
14. Appointment.extension:responsibleOrganization | |
SliceName | responsibleOrganization |
Definition | Organization responsible in a given context |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-responsible-organization) (Extension Type: Reference(ehealth-organization) : {r})) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
15. Appointment.extension:performer | |
SliceName | performer |
Definition | The actual performer in an appointment, eg. teacher in a group class |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-performer) (Extension Type: Reference(ehealth-careteamehealth-practitioner) : {r})) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
16. Appointment.extension:performingOrganization | |
SliceName | performingOrganization |
Definition | Organization who is performing in the given context |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-performing-organization) (Extension Type: Reference(ehealth-organization) : {r})) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
17. Appointment.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
18. Appointment.identifier | |
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Appointment.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
19. Appointment.identifier:vdxMeetingId | |
SliceName | vdxMeetingId |
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* |
Type | Identifier |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Appointment.identifier:vdxMeetingId.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. Appointment.identifier:vdxMeetingId.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 10..1 |
Type | uri |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Fixed Value | http://vdx.medcom.dk/meeting |
Example | General:http://www.acme.com/identifiers/patient |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. Appointment.status | |
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. |
Control | 1..1 |
Binding | The codes SHALL be taken from AppointmentStatus The free/busy status of an appointment. |
Type | code |
Is Modifier | true |
Comments | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. Appointment.serviceType | |
Definition | The specific service that is to be performed during this appointment. |
Control | 10..* |
Binding | For example codes, see ServiceType |
Type | CodeableConcept |
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Appointment.serviceType. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
24. Appointment.serviceType:appointmentType | |
SliceName | appointmentType |
Definition | The specific service that is to be performed during this appointment. |
Control | 10..1* |
Binding | For example codes, see ServiceType |
Type | CodeableConcept |
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Appointment.serviceType:appointmentType.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Binding | The codes SHALL be taken from Appointment Service TypeFor codes, see (unbound) |
Type | Coding |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Appointment.serviceType:appointmentType.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 10..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | video |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Appointment.appointmentType | |
Definition | The style of appointment or patient that has been booked in the slot (not service type). |
Control | 10..1 |
Binding | The codes SHALL be taken from Appointment Type CodesThe codes SHOULD be taken from hl7VS-appointmentReasonCodes |
Type | CodeableConcept |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. Appointment.reasonCode | |
Definition | The coded reason that this appointment is being scheduled. This is more clinical than administrative. |
Control | 0..1* |
Binding | The codes SHALL be taken from Appointment ReasonThe codes SHOULD be taken from EncounterReasonCodes |
Type | CodeableConcept |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Appointment.supportingInformation | |
Definition | Additional information to support the appointment provided when making the appointment. |
Control | 0..1* |
Type | Reference(ehealth-episodeofcare|ehealth-careplan|Resource) : {r}) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. Appointment.start | |
Definition | Date/Time that the appointment is to take place. |
Control | 10..1 |
Type | instant |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. Appointment.end | |
Definition | Date/Time that the appointment is to conclude. |
Control | 10..1 |
Type | instant |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. Appointment.participant | |
Definition | List of participants involved in the appointment. |
Control | 1..* |
Type | BackboneElement |
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. Appointment.participant.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Appointment.participant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
34. Appointment.participant.extension:careteam | |
SliceName | careteam |
Definition | Careteam |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-ext-careteam) (Extension Type: Reference(ehealth-careteam) : {r})) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
35. Appointment.participant.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
36. Appointment.participant.actor | |
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. |
Control | 0..1 |
Type | Reference(ehealth-patient|ehealth-practitioner|ehealth-relatedperson|Location|Patient|Practitioner|PractitionerRole|RelatedPerson|Device|HealthcareService) : {r}, {r}, {c}) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. Appointment.participant.status | |
Definition | Participation status of the actor. |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment. |
Type | code |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
1. Appointment | |||||
Definition | 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). | ||||
Control | 0..* | ||||
2. Appointment.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. Appointment.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. Appointment.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. Appointment.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. Appointment.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Alternate Names | narrativehtmlxhtmldisplay | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. Appointment.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resourcesanonymous resourcescontained resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
8. Appointment.extension | |||||
Definition | An Extension | ||||
Control | 1..* | ||||
Type | Extension | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Appointment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. Appointment.extension:endMeetingOnEndTime | |||||
SliceName | endMeetingOnEndTime | ||||
Definition | Indicates if a video meeting must end on end time | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-end-meeting-on-end-time) (Extension Type: boolean) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
10. Appointment.extension:maxParticipants | |||||
SliceName | maxParticipants | ||||
Definition | The maximum number of participants allowed to participate in a video meeting | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-max-participants) (Extension Type: integer) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
11. Appointment.extension:meetingUrl | |||||
SliceName | meetingUrl | ||||
Definition | The URL at which a video meeting will take place. Is provided by the service, not the client, and may not be updated | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-meeting-url) (Extension Type: uri) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
12. Appointment.extension:vmrUri | |||||
SliceName | vmrUri | ||||
Definition | Virtual Meeting Room URI that can be used in eg. webRTC clients. Is provided by the service, not the client, and may not be updated. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-vmr-uri) (Extension Type: uri) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
13. Appointment.extension:guestPinCode | |||||
SliceName | guestPinCode | ||||
Definition | The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-guest-pin-code) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
14. Appointment.extension:hostPinCode | |||||
SliceName | hostPinCode | ||||
Definition | The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable. Host PIN must be used in order to start the meeting | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-host-pin-code) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
15. Appointment.extension:responsible | |||||
SliceName | responsible | ||||
Definition | Individuals, careteam and/or organization who are responsible in the given context | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-responsible) (Extension Type: Reference(ehealth-careteamehealth-practitioner) : {r})) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
16. Appointment.extension:groupId | |||||
SliceName | groupId | ||||
Definition | A logical id identifying a set of messages, which have the same recipient (considered a 'group message'). Must be supplied by the client, eg. as a UUID | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-group-id) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
17. Appointment.extension:legalBasis | |||||
SliceName | legalBasis | ||||
Definition | Legal basis | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-legalBasis) (Extension Type: CodeableConcept) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) governance-1: When extension is used a Episode of Care MUST be referenced (: %resource.supportingInformation.reference.contains('EpisodeOfCare/')) responsible-2: Both 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()) | ||||
18. Appointment.extension:releasableResource | |||||
SliceName | releasableResource | ||||
Definition | Indicates if the resource may be shared through national document repositories | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-releasableResource) (Extension Type: boolean) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
19. Appointment.extension:responsibleOrganization | |||||
SliceName | responsibleOrganization | ||||
Definition | Organization responsible in a given context | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-responsible-organization) (Extension Type: Reference(ehealth-organization) : {r})) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
20. Appointment.extension:performer | |||||
SliceName | performer | ||||
Definition | The actual performer in an appointment, eg. teacher in a group class | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-performer) (Extension Type: Reference(ehealth-careteamehealth-practitioner) : {r})) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
21. Appointment.extension:performingOrganization | |||||
SliceName | performingOrganization | ||||
Definition | Organization who is performing in the given context | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-performing-organization) (Extension Type: Reference(ehealth-organization) : {r})) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
22. Appointment.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
23. Appointment.identifier | |||||
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Appointment.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
24. Appointment.identifier:vdxMeetingId | |||||
SliceName | vdxMeetingId | ||||
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. Appointment.identifier:vdxMeetingId.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
26. Appointment.identifier:vdxMeetingId.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Appointment.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
27. Appointment.identifier:vdxMeetingId.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Appointment.identifier:vdxMeetingId.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. Appointment.identifier:vdxMeetingId.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Comments | Identifier.system is always case sensitive. | ||||
Fixed Value | http://vdx.medcom.dk/meeting | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. Appointment.identifier:vdxMeetingId.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Example | General:123456 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. Appointment.identifier:vdxMeetingId.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
32. Appointment.identifier:vdxMeetingId.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization)) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
33. Appointment.status | |||||
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from AppointmentStatus The free/busy status of an appointment | ||||
Type | code | ||||
Is Modifier | true | ||||
Comments | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. Appointment.cancelationReason | |||||
Definition | The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply. | ||||
Control | 0..1 | ||||
Binding | For example codes, see AppointmentCancellationReason | ||||
Type | CodeableConcept | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Appointment.serviceCategory | |||||
Definition | A broad categorization of the service that is to be performed during this appointment. | ||||
Control | 0..* | ||||
Binding | For example codes, see ServiceCategory | ||||
Type | CodeableConcept | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. Appointment.serviceType | |||||
Definition | The specific service that is to be performed during this appointment. | ||||
Control | 1..* | ||||
Binding | For example codes, see ServiceType | ||||
Type | CodeableConcept | ||||
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Appointment.serviceType. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
37. Appointment.serviceType:appointmentType | |||||
SliceName | appointmentType | ||||
Definition | The specific service that is to be performed during this appointment. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ServiceType | ||||
Type | CodeableConcept | ||||
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. Appointment.serviceType:appointmentType.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
39. Appointment.serviceType:appointmentType.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Appointment.serviceType.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
40. Appointment.serviceType:appointmentType.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from Appointment Service Type | ||||
Type | Coding | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. Appointment.serviceType:appointmentType.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
42. Appointment.serviceType:appointmentType.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Appointment.serviceType.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
43. Appointment.serviceType:appointmentType.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. Appointment.serviceType:appointmentType.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. Appointment.serviceType:appointmentType.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | video | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. Appointment.serviceType:appointmentType.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
47. Appointment.serviceType:appointmentType.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. Appointment.serviceType:appointmentType.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. Appointment.specialty | |||||
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet | ||||
Type | CodeableConcept | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. Appointment.appointmentType | |||||
Definition | The style of appointment or patient that has been booked in the slot (not service type). | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Appointment Type Codes | ||||
Type | CodeableConcept | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. Appointment.reasonCode | |||||
Definition | The coded reason that this appointment is being scheduled. This is more clinical than administrative. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Appointment Reason | ||||
Type | CodeableConcept | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. Appointment.reasonReference | |||||
Definition | Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. | ||||
Control | 0..* | ||||
Type | Reference(ConditionProcedureObservationImmunizationRecommendation)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
53. Appointment.priority | |||||
Definition | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority). | ||||
Control | 0..1 | ||||
Type | unsignedInt | ||||
Comments | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. Appointment.description | |||||
Definition | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field. | ||||
Control | 0..1 | ||||
Type | string | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. Appointment.supportingInformation | |||||
Definition | Additional information to support the appointment provided when making the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(ehealth-episodeofcareehealth-careplan) : {r}) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. Appointment.start | |||||
Definition | Date/Time that the appointment is to take place. | ||||
Control | 1..1 | ||||
Type | instant | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. Appointment.end | |||||
Definition | Date/Time that the appointment is to conclude. | ||||
Control | 1..1 | ||||
Type | instant | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
58. Appointment.minutesDuration | |||||
Definition | Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end. | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
59. Appointment.slot | |||||
Definition | The slots from the participants' schedules that will be filled by the appointment. | ||||
Control | 0..* | ||||
Type | Reference(Slot)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
60. Appointment.created | |||||
Definition | The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Comments | This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
61. Appointment.comment | |||||
Definition | Additional comments about the appointment. | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
62. Appointment.patientInstruction | |||||
Definition | While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before). | ||||
Control | 0..1 | ||||
Type | string | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. Appointment.basedOn | |||||
Definition | The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). | ||||
Control | 0..* | ||||
Type | Reference(ServiceRequest)) | ||||
Alternate Names | incomingReferral | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
64. Appointment.participant | |||||
Definition | List of participants involved in the appointment. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
65. Appointment.participant.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
66. Appointment.participant.extension | |||||
Definition | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Appointment.participant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
67. Appointment.participant.extension:careteam | |||||
SliceName | careteam | ||||
Definition | Careteam | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-ext-careteam) (Extension Type: Reference(ehealth-careteam) : {r})) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
68. Appointment.participant.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensionsuser contentmodifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
69. Appointment.participant.type | |||||
Definition | Role of participant in the appointment. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter | ||||
Type | CodeableConcept | ||||
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
70. Appointment.participant.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(ehealth-patientehealth-practitionerehealth-relatedpersonLocation) : {r} {r} {c}) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
71. Appointment.participant.required | |||||
Definition | Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment | ||||
Type | code | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
72. Appointment.participant.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment | ||||
Type | code | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
73. Appointment.participant.period | |||||
Definition | Participation period of the actor. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
74. Appointment.requestedPeriod | |||||
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system. | ||||
Control | 0..* | ||||
Type | Period | ||||
Comments | This does not introduce a capacity for recurring appointments. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |