Extensions for Using Data Elements from FHIR R4B in FHIR R5 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/4.3/StructureDefinition/profile-Appointment | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R4B_Appointment_R5 | ||
This cross-version profile allows R4B Appointment content to be represented via FHIR R5 Appointment resources.
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Appointment(5.0.0) | 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, app-5, app-6, app-7 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) | R4B: Reason the appointment is to take place (resource) (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.reasonReference Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to take place |
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude |
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | Appointment Status | 📍5.0.0 | FHIR Std. |
| Appointment.participant.status | Base | required | Participation Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant | 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 | Cancellation reason is only used for appointments that have been cancelled, or noshow |
cancellationReason.exists() implies (status='noshow' or status='cancelled')
|
| app-5 | error | Appointment | The start must be less than or equal to the end |
start.exists() implies start <= end
|
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both |
originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
|
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow |
cancellationDate.exists() implies (status='noshow' or 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Appointment.implicitRules, Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.status, Appointment.start, Appointment.end, Appointment.participant, Appointment.participant.modifierExtension, Appointment.participant.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.participant.modifierExtension | 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: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Appointment(5.0.0) | 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, app-5, app-6, app-7 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) | R4B: Reason the appointment is to take place (resource) (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.reasonReference Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
![]() ![]() |
ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Hl7VSAppointmentReasonCodes (3.0.0) (preferred) | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
![]() ![]() |
0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (3.0.0) (example): Indicates the urgency of the appointment. | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | R4B: priority additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.priority Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
![]() ![]() |
0..* | Reference(Appointment) | Appointment replaced by this Appointment | |||||
![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
![]() ![]() |
0..1 | Reference(Appointment) | The previous appointment in a series | |||||
![]() ![]() |
C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments | ||||
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to take place | ||||
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude | ||||
![]() ![]() |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
![]() ![]() |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
![]() ![]() |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |||||
![]() ![]() |
0..1 | dateTime | The date that this appointment was initially created | |||||
![]() ![]() |
C | 0..1 | dateTime | When the appointment was cancelled | ||||
![]() ![]() |
0..* | Annotation | Additional comments | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | R4B: comment additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.comment Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() |
0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | R4B: patientInstruction additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.patientInstruction Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
![]() ![]() |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | The patient or group associated with the appointment | ||||
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]() |
ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | The individual, device, location, or service participating in the appointment | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | The participant is required to attend (optional when false) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | R4B: required | optional | information-only additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.participant.required Binding: R4BParticipantrequiredForR5 (0.1.0) (required): Is the Participant required to attend the appointment. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Primitive value for boolean | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
![]() ![]() |
0..1 | positiveInt | The sequence number in the recurrence | |||||
![]() ![]() |
0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |||||
![]() ![]() |
C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() |
0..1 | date | The date when the recurrence should end | |||||
![]() ![]() ![]() |
0..1 | positiveInt | The number of planned occurrences | |||||
![]() ![]() ![]() |
0..* | date | Specific dates for a recurring set of appointments (no template) | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about weekly recurring appointments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Mondays | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Tuesday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Wednesday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Thursday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Friday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Saturday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Sunday | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs every nth week | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about monthly recurring appointments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs on a specific day of the month | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth month | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about yearly recurring appointments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth year | |||||
![]() ![]() ![]() |
0..* | date | Any dates that should be excluded from the series | |||||
![]() ![]() ![]() |
0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Appointment.status | Base | required | Appointment Status | 📍5.0.0 | FHIR Std. |
| Appointment.cancellationReason | Base | example | Appointment Cancellation Reason | 📍5.0.0 | FHIR Std. |
| Appointment.class | Base | preferred | http://terminology.hl7.org/ValueSet/EncounterClass | Not State | Unknown |
| Appointment.serviceCategory | Base | example | Service Category | 📍5.0.0 | FHIR Std. |
| Appointment.serviceType | Base | example | Service Type | 📍5.0.0 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📍3.0.0 | THO v7.1 |
| Appointment.reason | Base | preferred | Encounter Reason Codes | 📍5.0.0 | FHIR Std. |
| Appointment.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1 |
| Appointment.participant.type | Base | extensible |
Participant Type
|
📍5.0.0 | tx.fhir.org |
| Appointment.participant.status | Base | required | Participation Status | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.timezone | Base | required | IANA Timezones | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.recurrenceType | Base | preferred | Appointment Recurrence Type | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | Base | required | Week Of Month | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | Base | required | Days Of Week | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant | 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 | Cancellation reason is only used for appointments that have been cancelled, or noshow |
cancellationReason.exists() implies (status='noshow' or status='cancelled')
|
| app-5 | error | Appointment | The start must be less than or equal to the end |
start.exists() implies start <= end
|
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both |
originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
|
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow |
cancellationDate.exists() implies (status='noshow' or 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Appointment.meta, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.identifier, Appointment.status, Appointment.cancellationReason, Appointment.class, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reason, Appointment.priority, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.priority.coding, Appointment.priority.text, Appointment.description, Appointment.replaces, Appointment.virtualService, Appointment.supportingInformation, Appointment.previousAppointment, Appointment.originatingAppointment, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.requestedPeriod, Appointment.slot, Appointment.account, Appointment.created, Appointment.cancellationDate, Appointment.note, Appointment.note.extension, Appointment.note.extension:comment, Appointment.note.author[x], Appointment.note.time, Appointment.note.text, Appointment.patientInstruction, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.patientInstruction.concept, Appointment.patientInstruction.reference, Appointment.basedOn, Appointment.subject, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, Appointment.participant.period, Appointment.participant.actor, Appointment.participant.required, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.participant.status, Appointment.recurrenceId, Appointment.occurrenceChanged, Appointment.recurrenceTemplate, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.timezone, Appointment.recurrenceTemplate.recurrenceType, Appointment.recurrenceTemplate.lastOccurrenceDate, Appointment.recurrenceTemplate.occurrenceCount, Appointment.recurrenceTemplate.occurrenceDate, Appointment.recurrenceTemplate.weeklyTemplate, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.monday, Appointment.recurrenceTemplate.weeklyTemplate.tuesday, Appointment.recurrenceTemplate.weeklyTemplate.wednesday, Appointment.recurrenceTemplate.weeklyTemplate.thursday, Appointment.recurrenceTemplate.weeklyTemplate.friday, Appointment.recurrenceTemplate.weeklyTemplate.saturday, Appointment.recurrenceTemplate.weeklyTemplate.sunday, Appointment.recurrenceTemplate.weeklyTemplate.weekInterval, Appointment.recurrenceTemplate.monthlyTemplate, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.dayOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek, Appointment.recurrenceTemplate.monthlyTemplate.monthInterval, Appointment.recurrenceTemplate.yearlyTemplate, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.yearInterval, Appointment.recurrenceTemplate.excludingDate, Appointment.recurrenceTemplate.excludingRecurrenceId | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.note.extension, Appointment.note.extension:comment, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Appointment(5.0.0) | 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, app-5, app-6, app-7 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) | R4B: Reason the appointment is to take place (resource) (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.reasonReference Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to take place |
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude |
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | Appointment Status | 📍5.0.0 | FHIR Std. |
| Appointment.participant.status | Base | required | Participation Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant | 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 | Cancellation reason is only used for appointments that have been cancelled, or noshow |
cancellationReason.exists() implies (status='noshow' or status='cancelled')
|
| app-5 | error | Appointment | The start must be less than or equal to the end |
start.exists() implies start <= end
|
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both |
originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
|
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow |
cancellationDate.exists() implies (status='noshow' or 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Appointment.implicitRules, Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.status, Appointment.start, Appointment.end, Appointment.participant, Appointment.participant.modifierExtension, Appointment.participant.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Appointment
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Appointment(5.0.0) | 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, app-5, app-6, app-7 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) | R4B: Reason the appointment is to take place (resource) (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.reasonReference Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
![]() ![]() |
ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: Hl7VSAppointmentReasonCodes (3.0.0) (preferred) | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
![]() ![]() |
0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (3.0.0) (example): Indicates the urgency of the appointment. | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | R4B: priority additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.priority Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
![]() ![]() |
0..* | Reference(Appointment) | Appointment replaced by this Appointment | |||||
![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
![]() ![]() |
0..1 | Reference(Appointment) | The previous appointment in a series | |||||
![]() ![]() |
C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments | ||||
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to take place | ||||
![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude | ||||
![]() ![]() |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
![]() ![]() |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
![]() ![]() |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |||||
![]() ![]() |
0..1 | dateTime | The date that this appointment was initially created | |||||
![]() ![]() |
C | 0..1 | dateTime | When the appointment was cancelled | ||||
![]() ![]() |
0..* | Annotation | Additional comments | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | R4B: comment additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.comment Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() |
0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | R4B: patientInstruction additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.patientInstruction Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
![]() ![]() |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | The patient or group associated with the appointment | ||||
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]() |
ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | The individual, device, location, or service participating in the appointment | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | The participant is required to attend (optional when false) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | R4B: required | optional | information-only additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Appointment.participant.required Binding: R4BParticipantrequiredForR5 (0.1.0) (required): Is the Participant required to attend the appointment. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Primitive value for boolean | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
![]() ![]() |
0..1 | positiveInt | The sequence number in the recurrence | |||||
![]() ![]() |
0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |||||
![]() ![]() |
C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() |
0..1 | date | The date when the recurrence should end | |||||
![]() ![]() ![]() |
0..1 | positiveInt | The number of planned occurrences | |||||
![]() ![]() ![]() |
0..* | date | Specific dates for a recurring set of appointments (no template) | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about weekly recurring appointments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Mondays | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Tuesday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Wednesday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Thursday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Friday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Saturday | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Sunday | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs every nth week | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about monthly recurring appointments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs on a specific day of the month | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth month | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about yearly recurring appointments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth year | |||||
![]() ![]() ![]() |
0..* | date | Any dates that should be excluded from the series | |||||
![]() ![]() ![]() |
0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Appointment.status | Base | required | Appointment Status | 📍5.0.0 | FHIR Std. |
| Appointment.cancellationReason | Base | example | Appointment Cancellation Reason | 📍5.0.0 | FHIR Std. |
| Appointment.class | Base | preferred | http://terminology.hl7.org/ValueSet/EncounterClass | Not State | Unknown |
| Appointment.serviceCategory | Base | example | Service Category | 📍5.0.0 | FHIR Std. |
| Appointment.serviceType | Base | example | Service Type | 📍5.0.0 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📍3.0.0 | THO v7.1 |
| Appointment.reason | Base | preferred | Encounter Reason Codes | 📍5.0.0 | FHIR Std. |
| Appointment.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1 |
| Appointment.participant.type | Base | extensible |
Participant Type
|
📍5.0.0 | tx.fhir.org |
| Appointment.participant.status | Base | required | Participation Status | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.timezone | Base | required | IANA Timezones | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.recurrenceType | Base | preferred | Appointment Recurrence Type | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | Base | required | Week Of Month | 📍5.0.0 | FHIR Std. |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | Base | required | Days Of Week | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant | 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 | Cancellation reason is only used for appointments that have been cancelled, or noshow |
cancellationReason.exists() implies (status='noshow' or status='cancelled')
|
| app-5 | error | Appointment | The start must be less than or equal to the end |
start.exists() implies start <= end
|
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both |
originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
|
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow |
cancellationDate.exists() implies (status='noshow' or 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Appointment.meta, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.identifier, Appointment.status, Appointment.cancellationReason, Appointment.class, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reason, Appointment.priority, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.priority.coding, Appointment.priority.text, Appointment.description, Appointment.replaces, Appointment.virtualService, Appointment.supportingInformation, Appointment.previousAppointment, Appointment.originatingAppointment, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.requestedPeriod, Appointment.slot, Appointment.account, Appointment.created, Appointment.cancellationDate, Appointment.note, Appointment.note.extension, Appointment.note.extension:comment, Appointment.note.author[x], Appointment.note.time, Appointment.note.text, Appointment.patientInstruction, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.patientInstruction.concept, Appointment.patientInstruction.reference, Appointment.basedOn, Appointment.subject, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, Appointment.participant.period, Appointment.participant.actor, Appointment.participant.required, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.participant.status, Appointment.recurrenceId, Appointment.occurrenceChanged, Appointment.recurrenceTemplate, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.timezone, Appointment.recurrenceTemplate.recurrenceType, Appointment.recurrenceTemplate.lastOccurrenceDate, Appointment.recurrenceTemplate.occurrenceCount, Appointment.recurrenceTemplate.occurrenceDate, Appointment.recurrenceTemplate.weeklyTemplate, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.monday, Appointment.recurrenceTemplate.weeklyTemplate.tuesday, Appointment.recurrenceTemplate.weeklyTemplate.wednesday, Appointment.recurrenceTemplate.weeklyTemplate.thursday, Appointment.recurrenceTemplate.weeklyTemplate.friday, Appointment.recurrenceTemplate.weeklyTemplate.saturday, Appointment.recurrenceTemplate.weeklyTemplate.sunday, Appointment.recurrenceTemplate.weeklyTemplate.weekInterval, Appointment.recurrenceTemplate.monthlyTemplate, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.dayOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek, Appointment.recurrenceTemplate.monthlyTemplate.monthInterval, Appointment.recurrenceTemplate.yearlyTemplate, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.yearInterval, Appointment.recurrenceTemplate.excludingDate, Appointment.recurrenceTemplate.excludingRecurrenceId | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Appointment.extension, Appointment.extension:reasonReference, Appointment.modifierExtension, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.note.extension, Appointment.note.extension:comment, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron