US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101
US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101
US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.10.0 See the Directory of published versions
| Official URL: http://va.gov/fhir/StructureDefinition/Appointment | Version: 1.10.0 | |||
| Active as of 2025-11-04 | Computable Name: Appointment | |||
This StructureDefinition contains the maps for VistA file APPOINTMENT (2.98) to Appointment.
See also the FHIR Shorthand.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Appointment |
C | 0..* | Appointment(4.0.1) | 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) Constraints: app-2, app-3, app-4 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:resource-serviceConnection |
S | 0..1 | (Complex) | Extension URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection |
  extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://va.gov/fhir/StructureDefinition/resource-serviceConnection" | |
  value[x] |
SC | 0..1 | Coding | Value of extension Binding: VSResourceServiceConnection (required) Constraints: a-11-2033, a-11-2034 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus FHIR (required): see mapping VF_AppointmentStatus Constraints: a-11-732, a-11-733, a-11-734, a-11-748 |
| cancelationReason |
SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason FHIR (required): see mapping VF_AppointmentCancellationReason |
 Slices for serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by value:$this Binding: ServiceCategory (example) |
| serviceCategory:va-stop-code |
SΣ | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://va.gov/terminology/VistADefinedTerms/409.3-13.4 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
 coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| system |
SΣ | 0..1 | uri | Identity of the terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) |
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
 reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |
| description |
S | 0..1 | string | Shown on a subject line in a meeting request, or appointment list |
| start |
SΣ | 0..1 | instant | When appointment is to take place |
| end |
SΣ | 0..1 | instant | When appointment is to conclude |
| minutesDuration |
S | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) |
| created |
S | 0..1 | dateTime | The date that this appointment was initially created |
| comment |
S | 0..1 | string | Additional comments |
 Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:$this Constraints: app-1 |
  participant:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:va-clinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
SΣ | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted |
| participant:va-patient |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| code |
SΣC | 0..1 | code | Symbol in syntax defined by the system Constraints: a-11-1722-1 |
| actor |
SΣC | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device Constraints: a-11-1722 |
| status |
SΣC | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Constraints: a-11-1722-2 |
| participant:va-apptclinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
SΣ | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.extension:resource-serviceConnection.value[x] | Base | required | VSResourceServiceConnection | 📦1.10.0 | This IG |
| Appointment.status | Base | required | AppointmentStatus FHIR | 📦1.10.0 | This IG |
| Appointment.cancelationReason | Base | required | AppointmentCancellationReason FHIR | 📦1.10.0 | This IG |
| Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceCategory:va-stop-code | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| a-11-732 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #booked |
true
|
| a-11-733 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #arrived |
true
|
| a-11-734 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), non-null check-out date (44.003-303) then fixed value #fulfilled |
true
|
| a-11-748 | best practice | Appointment.status | If (409.3-.01) is not null then fixed value #waitlist |
true
|
| a-11-1722 | best practice | Appointment.participant:va-patient.actor | If {1900>2.98} then reference /Patient based on (2-) |
true
|
| a-11-2033 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" |
true
|
| a-11-2034 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" |
true
|
| a-11-1722-1 | best practice | Appointment.participant:va-patient.type.coding.code | If {1900>2.98} then fixed value #PART |
true
|
| a-11-1722-2 | best practice | Appointment.participant:va-patient.status | If {1900>2.98} then fixed value #accepted |
true
|
| app-1 | error | Appointment.participant, Appointment.participant:va-clinic, Appointment.participant:va-patient, Appointment.participant:va-apptclinic | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | 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 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | error | 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-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
0..* | Appointment(4.0.1) | 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) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:resource-serviceConnection |
S | 0..1 | (Complex) | Extension URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection |
| value[x] |
SC | 0..1 | Coding | Value of extension Constraints: a-11-2033, a-11-2034 |
| status |
SC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus FHIR (required): see mapping VF_AppointmentStatus Constraints: a-11-732, a-11-733, a-11-734, a-11-748 |
| cancelationReason |
S | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason FHIR (required): see mapping VF_AppointmentCancellationReason |
| Slices for serviceCategory |
0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by value:$this | |
| serviceCategory:va-stop-code |
S | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://va.gov/terminology/VistADefinedTerms/409.3-13.4 | |
| coding |
||||
| system |
S | 0..1 | uri | Identity of the terminology system |
| code |
S | 0..1 | code | Symbol in syntax defined by the system |
| specialty |
0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment | |
| appointmentType |
||||
| text |
S | 0..1 | string | Plain text representation of the concept |
| reasonCode |
0..* | CodeableConcept | Coded reason this appointment is scheduled | |
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |
| description |
S | 0..1 | string | Shown on a subject line in a meeting request, or appointment list |
| start |
S | 0..1 | instant | When appointment is to take place |
| end |
S | 0..1 | instant | When appointment is to conclude |
| minutesDuration |
S | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) |
| created |
S | 0..1 | dateTime | The date that this appointment was initially created |
| comment |
S | 0..1 | string | Additional comments |
| Slices for participant |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:$this | |
| participant:va-clinic |
S | 0..1 | BackboneElement | Participants involved in appointment |
| type |
||||
| coding |
||||
| code |
S | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
S | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: accepted |
| participant:va-patient |
S | 0..1 | BackboneElement | Participants involved in appointment |
| type |
||||
| coding |
||||
| code |
SC | 0..1 | code | Symbol in syntax defined by the system Constraints: a-11-1722-1 |
| actor |
SC | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device Constraints: a-11-1722 |
| status |
SC | 1..1 | code | accepted | declined | tentative | needs-action Constraints: a-11-1722-2 |
| participant:va-apptclinic |
S | 0..1 | BackboneElement | Participants involved in appointment |
| type |
||||
| coding |
||||
| code |
S | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
S | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: tentative |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | AppointmentStatus FHIR | 📦1.10.0 | This IG |
| Appointment.cancelationReason | Base | required | AppointmentCancellationReason FHIR | 📦1.10.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| a-11-732 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #booked |
true
|
| a-11-733 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #arrived |
true
|
| a-11-734 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), non-null check-out date (44.003-303) then fixed value #fulfilled |
true
|
| a-11-748 | best practice | Appointment.status | If (409.3-.01) is not null then fixed value #waitlist |
true
|
| a-11-1722 | best practice | Appointment.participant:va-patient.actor | If {1900>2.98} then reference /Patient based on (2-) |
true
|
| a-11-2033 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" |
true
|
| a-11-2034 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" |
true
|
| a-11-1722-1 | best practice | Appointment.participant:va-patient.type.coding.code | If {1900>2.98} then fixed value #PART |
true
|
| a-11-1722-2 | best practice | Appointment.participant:va-patient.status | If {1900>2.98} then fixed value #accepted |
true
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment(4.0.1) | 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) Constraints: app-2, app-3, app-4 | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:resource-serviceConnection |
S | 0..1 | (Complex) | Extension URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://va.gov/fhir/StructureDefinition/resource-serviceConnection" | |||||
| value[x] |
SC | 0..1 | Coding | Value of extension Binding: VSResourceServiceConnection (required) Constraints: a-11-2033, a-11-2034 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!SΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus FHIR (required): see mapping VF_AppointmentStatus Constraints: a-11-732, a-11-733, a-11-734, a-11-748 | ||||
| cancelationReason |
SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason FHIR (required): see mapping VF_AppointmentCancellationReason | ||||
| Slices for serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by value:$this Binding: ServiceCategory (example) | ||||
| serviceCategory:va-stop-code |
SΣ | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://va.gov/terminology/VistADefinedTerms/409.3-13.4 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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: PracticeSettingCodeValueSet (preferred) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
| priority |
0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
| description |
S | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | ||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| start |
SΣ | 0..1 | instant | When appointment is to take place | ||||
| end |
SΣ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration |
S | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | ||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created |
S | 0..1 | dateTime | The date that this appointment was initially created | ||||
| comment |
S | 0..1 | string | Additional comments | ||||
| patientInstruction |
0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:$this Constraints: app-1 | ||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:va-clinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| actor |
SΣ | 0..1 | Reference(Location) | 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 |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:va-patient |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣC | 0..1 | code | Symbol in syntax defined by the system Constraints: a-11-1722-1 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| actor |
SΣC | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device Constraints: a-11-1722 | ||||
| required |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status |
SΣC | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Constraints: a-11-1722-2 | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:va-apptclinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| actor |
SΣ | 0..1 | Reference(Location) | 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 |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.extension:resource-serviceConnection.value[x] | Base | required | VSResourceServiceConnection | 📦1.10.0 | This IG |
| Appointment.status | Base | required | AppointmentStatus FHIR | 📦1.10.0 | This IG |
| Appointment.cancelationReason | Base | required | AppointmentCancellationReason FHIR | 📦1.10.0 | This IG |
| Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceCategory:va-stop-code | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| a-11-732 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #booked |
true
|
| a-11-733 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #arrived |
true
|
| a-11-734 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), non-null check-out date (44.003-303) then fixed value #fulfilled |
true
|
| a-11-748 | best practice | Appointment.status | If (409.3-.01) is not null then fixed value #waitlist |
true
|
| a-11-1722 | best practice | Appointment.participant:va-patient.actor | If {1900>2.98} then reference /Patient based on (2-) |
true
|
| a-11-2033 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" |
true
|
| a-11-2034 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" |
true
|
| a-11-1722-1 | best practice | Appointment.participant:va-patient.type.coding.code | If {1900>2.98} then fixed value #PART |
true
|
| a-11-1722-2 | best practice | Appointment.participant:va-patient.status | If {1900>2.98} then fixed value #accepted |
true
|
| app-1 | error | Appointment.participant, Appointment.participant:va-clinic, Appointment.participant:va-patient, Appointment.participant:va-apptclinic | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | 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 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | error | 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-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
Summary
Must-Support: 26 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment(4.0.1) | 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) Constraints: app-2, app-3, app-4 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:resource-serviceConnection |
S | 0..1 | (Complex) | Extension URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://va.gov/fhir/StructureDefinition/resource-serviceConnection" | |
| value[x] |
SC | 0..1 | Coding | Value of extension Binding: VSResourceServiceConnection (required) Constraints: a-11-2033, a-11-2034 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus FHIR (required): see mapping VF_AppointmentStatus Constraints: a-11-732, a-11-733, a-11-734, a-11-748 |
| cancelationReason |
SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason FHIR (required): see mapping VF_AppointmentCancellationReason |
| Slices for serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by value:$this Binding: ServiceCategory (example) |
| serviceCategory:va-stop-code |
SΣ | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://va.gov/terminology/VistADefinedTerms/409.3-13.4 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| system |
SΣ | 0..1 | uri | Identity of the terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) |
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |
| description |
S | 0..1 | string | Shown on a subject line in a meeting request, or appointment list |
| start |
SΣ | 0..1 | instant | When appointment is to take place |
| end |
SΣ | 0..1 | instant | When appointment is to conclude |
| minutesDuration |
S | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) |
| created |
S | 0..1 | dateTime | The date that this appointment was initially created |
| comment |
S | 0..1 | string | Additional comments |
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:$this Constraints: app-1 |
| participant:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:va-clinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
SΣ | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted |
| participant:va-patient |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| code |
SΣC | 0..1 | code | Symbol in syntax defined by the system Constraints: a-11-1722-1 |
| actor |
SΣC | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device Constraints: a-11-1722 |
| status |
SΣC | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Constraints: a-11-1722-2 |
| participant:va-apptclinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
SΣ | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.extension:resource-serviceConnection.value[x] | Base | required | VSResourceServiceConnection | 📦1.10.0 | This IG |
| Appointment.status | Base | required | AppointmentStatus FHIR | 📦1.10.0 | This IG |
| Appointment.cancelationReason | Base | required | AppointmentCancellationReason FHIR | 📦1.10.0 | This IG |
| Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceCategory:va-stop-code | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| a-11-732 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #booked |
true
|
| a-11-733 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #arrived |
true
|
| a-11-734 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), non-null check-out date (44.003-303) then fixed value #fulfilled |
true
|
| a-11-748 | best practice | Appointment.status | If (409.3-.01) is not null then fixed value #waitlist |
true
|
| a-11-1722 | best practice | Appointment.participant:va-patient.actor | If {1900>2.98} then reference /Patient based on (2-) |
true
|
| a-11-2033 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" |
true
|
| a-11-2034 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" |
true
|
| a-11-1722-1 | best practice | Appointment.participant:va-patient.type.coding.code | If {1900>2.98} then fixed value #PART |
true
|
| a-11-1722-2 | best practice | Appointment.participant:va-patient.status | If {1900>2.98} then fixed value #accepted |
true
|
| app-1 | error | Appointment.participant, Appointment.participant:va-clinic, Appointment.participant:va-patient, Appointment.participant:va-apptclinic | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | 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 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | error | 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-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
0..* | Appointment(4.0.1) | 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) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:resource-serviceConnection |
S | 0..1 | (Complex) | Extension URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection |
| value[x] |
SC | 0..1 | Coding | Value of extension Constraints: a-11-2033, a-11-2034 |
| status |
SC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus FHIR (required): see mapping VF_AppointmentStatus Constraints: a-11-732, a-11-733, a-11-734, a-11-748 |
| cancelationReason |
S | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason FHIR (required): see mapping VF_AppointmentCancellationReason |
| Slices for serviceCategory |
0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by value:$this | |
| serviceCategory:va-stop-code |
S | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://va.gov/terminology/VistADefinedTerms/409.3-13.4 | |
| coding |
||||
| system |
S | 0..1 | uri | Identity of the terminology system |
| code |
S | 0..1 | code | Symbol in syntax defined by the system |
| specialty |
0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment | |
| appointmentType |
||||
| text |
S | 0..1 | string | Plain text representation of the concept |
| reasonCode |
0..* | CodeableConcept | Coded reason this appointment is scheduled | |
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |
| description |
S | 0..1 | string | Shown on a subject line in a meeting request, or appointment list |
| start |
S | 0..1 | instant | When appointment is to take place |
| end |
S | 0..1 | instant | When appointment is to conclude |
| minutesDuration |
S | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) |
| created |
S | 0..1 | dateTime | The date that this appointment was initially created |
| comment |
S | 0..1 | string | Additional comments |
| Slices for participant |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:$this | |
| participant:va-clinic |
S | 0..1 | BackboneElement | Participants involved in appointment |
| type |
||||
| coding |
||||
| code |
S | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
S | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: accepted |
| participant:va-patient |
S | 0..1 | BackboneElement | Participants involved in appointment |
| type |
||||
| coding |
||||
| code |
SC | 0..1 | code | Symbol in syntax defined by the system Constraints: a-11-1722-1 |
| actor |
SC | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device Constraints: a-11-1722 |
| status |
SC | 1..1 | code | accepted | declined | tentative | needs-action Constraints: a-11-1722-2 |
| participant:va-apptclinic |
S | 0..1 | BackboneElement | Participants involved in appointment |
| type |
||||
| coding |
||||
| code |
S | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART |
| actor |
S | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device |
| status |
S | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: tentative |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | AppointmentStatus FHIR | 📦1.10.0 | This IG |
| Appointment.cancelationReason | Base | required | AppointmentCancellationReason FHIR | 📦1.10.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| a-11-732 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #booked |
true
|
| a-11-733 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #arrived |
true
|
| a-11-734 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), non-null check-out date (44.003-303) then fixed value #fulfilled |
true
|
| a-11-748 | best practice | Appointment.status | If (409.3-.01) is not null then fixed value #waitlist |
true
|
| a-11-1722 | best practice | Appointment.participant:va-patient.actor | If {1900>2.98} then reference /Patient based on (2-) |
true
|
| a-11-2033 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" |
true
|
| a-11-2034 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" |
true
|
| a-11-1722-1 | best practice | Appointment.participant:va-patient.type.coding.code | If {1900>2.98} then fixed value #PART |
true
|
| a-11-1722-2 | best practice | Appointment.participant:va-patient.status | If {1900>2.98} then fixed value #accepted |
true
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment(4.0.1) | 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) Constraints: app-2, app-3, app-4 | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:resource-serviceConnection |
S | 0..1 | (Complex) | Extension URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://va.gov/fhir/StructureDefinition/resource-serviceConnection" | |||||
| value[x] |
SC | 0..1 | Coding | Value of extension Binding: VSResourceServiceConnection (required) Constraints: a-11-2033, a-11-2034 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!SΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus FHIR (required): see mapping VF_AppointmentStatus Constraints: a-11-732, a-11-733, a-11-734, a-11-748 | ||||
| cancelationReason |
SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason FHIR (required): see mapping VF_AppointmentCancellationReason | ||||
| Slices for serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by value:$this Binding: ServiceCategory (example) | ||||
| serviceCategory:va-stop-code |
SΣ | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://va.gov/terminology/VistADefinedTerms/409.3-13.4 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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: PracticeSettingCodeValueSet (preferred) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
| priority |
0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
| description |
S | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | ||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| start |
SΣ | 0..1 | instant | When appointment is to take place | ||||
| end |
SΣ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration |
S | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | ||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created |
S | 0..1 | dateTime | The date that this appointment was initially created | ||||
| comment |
S | 0..1 | string | Additional comments | ||||
| patientInstruction |
0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:$this Constraints: app-1 | ||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:va-clinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| actor |
SΣ | 0..1 | Reference(Location) | 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 |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:va-patient |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣC | 0..1 | code | Symbol in syntax defined by the system Constraints: a-11-1722-1 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| actor |
SΣC | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device Constraints: a-11-1722 | ||||
| required |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status |
SΣC | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Constraints: a-11-1722-2 | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:va-apptclinic |
SC | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PART | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| actor |
SΣ | 0..1 | Reference(Location) | 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 |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: tentative | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.extension:resource-serviceConnection.value[x] | Base | required | VSResourceServiceConnection | 📦1.10.0 | This IG |
| Appointment.status | Base | required | AppointmentStatus FHIR | 📦1.10.0 | This IG |
| Appointment.cancelationReason | Base | required | AppointmentCancellationReason FHIR | 📦1.10.0 | This IG |
| Appointment.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceCategory:va-stop-code | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-clinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:va-apptclinic.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| a-11-732 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #booked |
true
|
| a-11-733 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), null check-out date (44.003-303) then fixed value #arrived |
true
|
| a-11-734 | best practice | Appointment.status | If (2.98-3) is I, NT, Null; Non-null check-in date (44.003-309), non-null check-out date (44.003-303) then fixed value #fulfilled |
true
|
| a-11-748 | best practice | Appointment.status | If (409.3-.01) is not null then fixed value #waitlist |
true
|
| a-11-1722 | best practice | Appointment.participant:va-patient.actor | If {1900>2.98} then reference /Patient based on (2-) |
true
|
| a-11-2033 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" |
true
|
| a-11-2034 | best practice | Appointment.extension:resource-serviceConnection.value[x] | If (2.98-9.5 > 409.1-.01) is Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" |
true
|
| a-11-1722-1 | best practice | Appointment.participant:va-patient.type.coding.code | If {1900>2.98} then fixed value #PART |
true
|
| a-11-1722-2 | best practice | Appointment.participant:va-patient.status | If {1900>2.98} then fixed value #accepted |
true
|
| app-1 | error | Appointment.participant, Appointment.participant:va-clinic, Appointment.participant:va-patient, Appointment.participant:va-apptclinic | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | 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 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | error | 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-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
Summary
Must-Support: 26 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron